Reference documentation and code samples for the Google BigQuery Reservation V1 Client class CreateCapacityCommitmentRequest.
The request for ReservationService.CreateCapacityCommitment.
Generated from protobuf message google.cloud.bigquery.reservation.v1.CreateCapacityCommitmentRequest
Namespace
Google \ Cloud \ BigQuery \ Reservation \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Resource name of the parent reservation. E.g., |
↳ capacity_commitment |
Google\Cloud\BigQuery\Reservation\V1\CapacityCommitment
Content of the capacity commitment to create. |
↳ enforce_single_admin_project_per_org |
bool
If true, fail the request if another project in the organization has a capacity commitment. |
↳ capacity_commitment_id |
string
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged. |
getParent
Required. Resource name of the parent reservation. E.g.,
projects/myproject/locations/US
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. Resource name of the parent reservation. E.g.,
projects/myproject/locations/US
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCapacityCommitment
Content of the capacity commitment to create.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BigQuery\Reservation\V1\CapacityCommitment|null | |
hasCapacityCommitment
clearCapacityCommitment
setCapacityCommitment
Content of the capacity commitment to create.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BigQuery\Reservation\V1\CapacityCommitment
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnforceSingleAdminProjectPerOrg
If true, fail the request if another project in the organization has a capacity commitment.
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnforceSingleAdminProjectPerOrg
If true, fail the request if another project in the organization has a capacity commitment.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCapacityCommitmentId
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty.
This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
| Returns | |
|---|---|
| Type | Description |
string | |
setCapacityCommitmentId
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty.
This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. Resource name of the parent reservation. E.g.,
|
capacityCommitment |
Google\Cloud\BigQuery\Reservation\V1\CapacityCommitment
Content of the capacity commitment to create. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BigQuery\Reservation\V1\CreateCapacityCommitmentRequest | |