- 2.56.0 (latest)
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.6
- 2.3.1
- 2.2.7
- 2.1.4
public interface CapacityCommitmentOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCommitmentEndTime()
public abstract Timestamp getCommitmentEndTime()Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after renewal, commitment_end_time is the time the renewed commitment expires. So it would be at a time after commitment_start_time + committed period, because we don't change commitment_start_time ,
.google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The commitmentEndTime. |
getCommitmentEndTimeOrBuilder()
public abstract TimestampOrBuilder getCommitmentEndTimeOrBuilder()Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after renewal, commitment_end_time is the time the renewed commitment expires. So it would be at a time after commitment_start_time + committed period, because we don't change commitment_start_time ,
.google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getCommitmentStartTime()
public abstract Timestamp getCommitmentStartTime()Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after the commitment is renewed, commitment_start_time won't be changed. It refers to the start time of the original commitment.
.google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The commitmentStartTime. |
getCommitmentStartTimeOrBuilder()
public abstract TimestampOrBuilder getCommitmentStartTimeOrBuilder()Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after the commitment is renewed, commitment_start_time won't be changed. It refers to the start time of the original commitment.
.google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getEdition()
public abstract Edition getEdition()Edition of the capacity commitment.
.google.cloud.bigquery.reservation.v1.Edition edition = 12;
| Returns | |
|---|---|
| Type | Description |
Edition |
The edition. |
getEditionValue()
public abstract int getEditionValue()Edition of the capacity commitment.
.google.cloud.bigquery.reservation.v1.Edition edition = 12;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for edition. |
getFailureStatus()
public abstract Status getFailureStatus()Output only. For FAILED commitment plan, provides the reason of failure.
.google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status |
The failureStatus. |
getFailureStatusOrBuilder()
public abstract StatusOrBuilder getFailureStatusOrBuilder()Output only. For FAILED commitment plan, provides the reason of failure.
.google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder |
|
getIsFlatRate()
public abstract boolean getIsFlatRate()Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.
bool is_flat_rate = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The isFlatRate. |
getMultiRegionAuxiliary()
public abstract boolean 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.
bool multi_region_auxiliary = 10;
| Returns | |
|---|---|
| Type | Description |
boolean |
The multiRegionAuxiliary. |
getName()
public abstract String 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.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() 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.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getPlan()
public abstract CapacityCommitment.CommitmentPlan getPlan()Capacity commitment commitment plan.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;
| Returns | |
|---|---|
| Type | Description |
CapacityCommitment.CommitmentPlan |
The plan. |
getPlanValue()
public abstract int getPlanValue()Capacity commitment commitment plan.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for plan. |
getRenewalPlan()
public abstract CapacityCommitment.CommitmentPlan 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.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan renewal_plan = 8;
| Returns | |
|---|---|
| Type | Description |
CapacityCommitment.CommitmentPlan |
The renewalPlan. |
getRenewalPlanValue()
public abstract int getRenewalPlanValue()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.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan renewal_plan = 8;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for renewalPlan. |
getSlotCount()
public abstract long getSlotCount()Number of slots in this commitment.
int64 slot_count = 2;
| Returns | |
|---|---|
| Type | Description |
long |
The slotCount. |
getState()
public abstract CapacityCommitment.State getState()Output only. State of the commitment.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CapacityCommitment.State |
The state. |
getStateValue()
public abstract int getStateValue()Output only. State of the commitment.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
hasCommitmentEndTime()
public abstract boolean hasCommitmentEndTime()Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after renewal, commitment_end_time is the time the renewed commitment expires. So it would be at a time after commitment_start_time + committed period, because we don't change commitment_start_time ,
.google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the commitmentEndTime field is set. |
hasCommitmentStartTime()
public abstract boolean hasCommitmentStartTime()Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after the commitment is renewed, commitment_start_time won't be changed. It refers to the start time of the original commitment.
.google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the commitmentStartTime field is set. |
hasFailureStatus()
public abstract boolean hasFailureStatus()Output only. For FAILED commitment plan, provides the reason of failure.
.google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the failureStatus field is set. |