Reference documentation and code samples for the Google BigQuery Reservation V1 Client class CapacityCommitment.
Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes.
In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.
Generated from protobuf message google.cloud.bigquery.reservation.v1.CapacityCommitment
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name of the capacity commitment, e.g., |
↳ slot_count |
int|string
Number of slots in this commitment. |
↳ plan |
int
Capacity commitment commitment plan. |
↳ state |
int
Output only. State of the commitment. |
↳ commitment_start_time |
Google\Protobuf\Timestamp
Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. |
↳ commitment_end_time |
Google\Protobuf\Timestamp
Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. |
↳ failure_status |
Google\Rpc\Status
Output only. For FAILED commitment plan, provides the reason of failure. |
↳ renewal_plan |
int
The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. |
↳ multi_region_auxiliary |
bool
Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. |
↳ edition |
int
Edition of the capacity commitment. |
getName
Output only. The resource name of the capacity commitment, e.g.,
projects/myproject/locations/US/capacityCommitments/123
The commitment_id must only contain lower case alphanumeric characters or
dashes. It must start with a letter and must not end
with a dash. Its maximum length is 64 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The resource name of the capacity commitment, e.g.,
projects/myproject/locations/US/capacityCommitments/123
The commitment_id must only contain lower case alphanumeric characters or
dashes. It must start with a letter and must not end
with a dash. Its maximum length is 64 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSlotCount
Number of slots in this commitment.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setSlotCount
Number of slots in this commitment.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPlan
Capacity commitment commitment plan.
| Returns | |
|---|---|
| Type | Description |
int | |
setPlan
Capacity commitment commitment plan.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. State of the commitment.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. State of the commitment.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCommitmentStartTime
Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCommitmentStartTime
clearCommitmentStartTime
setCommitmentStartTime
Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCommitmentEndTime
Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCommitmentEndTime
clearCommitmentEndTime
setCommitmentEndTime
Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFailureStatus
Output only. For FAILED commitment plan, provides the reason of failure.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasFailureStatus
clearFailureStatus
setFailureStatus
Output only. For FAILED commitment plan, provides the reason of failure.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRenewalPlan
The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
| Returns | |
|---|---|
| Type | Description |
int | |
setRenewalPlan
The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMultiRegionAuxiliary
Applicable only for commitments located within one of the BigQuery multi-regions (US or EU).
If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
| Returns | |
|---|---|
| Type | Description |
bool | |
setMultiRegionAuxiliary
Applicable only for commitments located within one of the BigQuery multi-regions (US or EU).
If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEdition
Edition of the capacity commitment.
| Returns | |
|---|---|
| Type | Description |
int | |
setEdition
Edition of the capacity commitment.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |