- 2.54.0 (latest)
- 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 static final class CapacityCommitment.Builder extends GeneratedMessageV3.Builder<CapacityCommitment.Builder> implements CapacityCommitmentOrBuilderCapacity 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.
Protobuf type google.cloud.bigquery.reservation.v1.CapacityCommitment
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CapacityCommitment.BuilderImplements
CapacityCommitmentOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CapacityCommitment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| CapacityCommitment.Builder |
build()
public CapacityCommitment build()| Type | Description |
| CapacityCommitment |
buildPartial()
public CapacityCommitment buildPartial()| Type | Description |
| CapacityCommitment |
clear()
public CapacityCommitment.Builder clear()| Type | Description |
| CapacityCommitment.Builder |
clearCommitmentEndTime()
public CapacityCommitment.Builder clearCommitmentEndTime()Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| CapacityCommitment.Builder |
clearCommitmentStartTime()
public CapacityCommitment.Builder clearCommitmentStartTime()Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| CapacityCommitment.Builder |
clearFailureStatus()
public CapacityCommitment.Builder clearFailureStatus()Output only. For FAILED commitment plan, provides the reason of failure.
.google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| CapacityCommitment.Builder |
clearField(Descriptors.FieldDescriptor field)
public CapacityCommitment.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| CapacityCommitment.Builder |
clearMultiRegionAuxiliary()
public CapacityCommitment.Builder clearMultiRegionAuxiliary()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.
bool multi_region_auxiliary = 10;
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
clearName()
public CapacityCommitment.Builder clearName() 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];
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CapacityCommitment.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| CapacityCommitment.Builder |
clearPlan()
public CapacityCommitment.Builder clearPlan()Capacity commitment commitment plan.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
clearRenewalPlan()
public CapacityCommitment.Builder clearRenewalPlan()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;
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
clearSlotCount()
public CapacityCommitment.Builder clearSlotCount()Number of slots in this commitment.
int64 slot_count = 2;
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
clearState()
public CapacityCommitment.Builder clearState()Output only. State of the commitment.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
clone()
public CapacityCommitment.Builder clone()| Type | Description |
| CapacityCommitment.Builder |
getCommitmentEndTime()
public Timestamp getCommitmentEndTime()Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Timestamp | The commitmentEndTime. |
getCommitmentEndTimeBuilder()
public Timestamp.Builder getCommitmentEndTimeBuilder()Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Builder |
getCommitmentEndTimeOrBuilder()
public TimestampOrBuilder getCommitmentEndTimeOrBuilder()Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| TimestampOrBuilder |
getCommitmentStartTime()
public Timestamp getCommitmentStartTime()Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Timestamp | The commitmentStartTime. |
getCommitmentStartTimeBuilder()
public Timestamp.Builder getCommitmentStartTimeBuilder()Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Builder |
getCommitmentStartTimeOrBuilder()
public TimestampOrBuilder getCommitmentStartTimeOrBuilder()Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| TimestampOrBuilder |
getDefaultInstanceForType()
public CapacityCommitment getDefaultInstanceForType()| Type | Description |
| CapacityCommitment |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getFailureStatus()
public 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];
| Type | Description |
| com.google.rpc.Status | The failureStatus. |
getFailureStatusBuilder()
public Status.Builder getFailureStatusBuilder()Output only. For FAILED commitment plan, provides the reason of failure.
.google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| com.google.rpc.Status.Builder |
getFailureStatusOrBuilder()
public 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];
| Type | Description |
| com.google.rpc.StatusOrBuilder |
getMultiRegionAuxiliary()
public 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.
bool multi_region_auxiliary = 10;
| Type | Description |
| boolean | The multiRegionAuxiliary. |
getName()
public 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];
| Type | Description |
| String | The name. |
getNameBytes()
public 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];
| Type | Description |
| ByteString | The bytes for name. |
getPlan()
public CapacityCommitment.CommitmentPlan getPlan()Capacity commitment commitment plan.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;
| Type | Description |
| CapacityCommitment.CommitmentPlan | The plan. |
getPlanValue()
public int getPlanValue()Capacity commitment commitment plan.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;
| Type | Description |
| int | The enum numeric value on the wire for plan. |
getRenewalPlan()
public 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;
| Type | Description |
| CapacityCommitment.CommitmentPlan | The renewalPlan. |
getRenewalPlanValue()
public 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;
| Type | Description |
| int | The enum numeric value on the wire for renewalPlan. |
getSlotCount()
public long getSlotCount()Number of slots in this commitment.
int64 slot_count = 2;
| Type | Description |
| long | The slotCount. |
getState()
public CapacityCommitment.State getState()Output only. State of the commitment.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| CapacityCommitment.State | The state. |
getStateValue()
public int getStateValue()Output only. State of the commitment.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for state. |
hasCommitmentEndTime()
public boolean hasCommitmentEndTime()Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the commitmentEndTime field is set. |
hasCommitmentStartTime()
public boolean hasCommitmentStartTime()Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the commitmentStartTime field is set. |
hasFailureStatus()
public 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];
| Type | Description |
| boolean | Whether the failureStatus field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeCommitmentEndTime(Timestamp value)
public CapacityCommitment.Builder mergeCommitmentEndTime(Timestamp value)Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| CapacityCommitment.Builder |
mergeCommitmentStartTime(Timestamp value)
public CapacityCommitment.Builder mergeCommitmentStartTime(Timestamp value)Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| CapacityCommitment.Builder |
mergeFailureStatus(Status value)
public CapacityCommitment.Builder mergeFailureStatus(Status value)Output only. For FAILED commitment plan, provides the reason of failure.
.google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | com.google.rpc.Status |
| Type | Description |
| CapacityCommitment.Builder |
mergeFrom(CapacityCommitment other)
public CapacityCommitment.Builder mergeFrom(CapacityCommitment other)| Name | Description |
| other | CapacityCommitment |
| Type | Description |
| CapacityCommitment.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CapacityCommitment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| CapacityCommitment.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public CapacityCommitment.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| CapacityCommitment.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CapacityCommitment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| CapacityCommitment.Builder |
setCommitmentEndTime(Timestamp value)
public CapacityCommitment.Builder setCommitmentEndTime(Timestamp value)Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| CapacityCommitment.Builder |
setCommitmentEndTime(Timestamp.Builder builderForValue)
public CapacityCommitment.Builder setCommitmentEndTime(Timestamp.Builder builderForValue)Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| CapacityCommitment.Builder |
setCommitmentStartTime(Timestamp value)
public CapacityCommitment.Builder setCommitmentStartTime(Timestamp value)Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| CapacityCommitment.Builder |
setCommitmentStartTime(Timestamp.Builder builderForValue)
public CapacityCommitment.Builder setCommitmentStartTime(Timestamp.Builder builderForValue)Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
.google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| CapacityCommitment.Builder |
setFailureStatus(Status value)
public CapacityCommitment.Builder setFailureStatus(Status value)Output only. For FAILED commitment plan, provides the reason of failure.
.google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | com.google.rpc.Status |
| Type | Description |
| CapacityCommitment.Builder |
setFailureStatus(Status.Builder builderForValue)
public CapacityCommitment.Builder setFailureStatus(Status.Builder builderForValue)Output only. For FAILED commitment plan, provides the reason of failure.
.google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| builderForValue | com.google.rpc.Status.Builder |
| Type | Description |
| CapacityCommitment.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public CapacityCommitment.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| CapacityCommitment.Builder |
setMultiRegionAuxiliary(boolean value)
public CapacityCommitment.Builder setMultiRegionAuxiliary(boolean value)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.
bool multi_region_auxiliary = 10;
| Name | Description |
| value | booleanThe multiRegionAuxiliary to set. |
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
setName(String value)
public CapacityCommitment.Builder setName(String value) 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];
| Name | Description |
| value | StringThe name to set. |
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public CapacityCommitment.Builder setNameBytes(ByteString value) 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];
| Name | Description |
| value | ByteStringThe bytes for name to set. |
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
setPlan(CapacityCommitment.CommitmentPlan value)
public CapacityCommitment.Builder setPlan(CapacityCommitment.CommitmentPlan value)Capacity commitment commitment plan.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;
| Name | Description |
| value | CapacityCommitment.CommitmentPlanThe plan to set. |
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
setPlanValue(int value)
public CapacityCommitment.Builder setPlanValue(int value)Capacity commitment commitment plan.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;
| Name | Description |
| value | intThe enum numeric value on the wire for plan to set. |
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
setRenewalPlan(CapacityCommitment.CommitmentPlan value)
public CapacityCommitment.Builder setRenewalPlan(CapacityCommitment.CommitmentPlan value)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;
| Name | Description |
| value | CapacityCommitment.CommitmentPlanThe renewalPlan to set. |
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
setRenewalPlanValue(int value)
public CapacityCommitment.Builder setRenewalPlanValue(int value)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;
| Name | Description |
| value | intThe enum numeric value on the wire for renewalPlan to set. |
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CapacityCommitment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| CapacityCommitment.Builder |
setSlotCount(long value)
public CapacityCommitment.Builder setSlotCount(long value)Number of slots in this commitment.
int64 slot_count = 2;
| Name | Description |
| value | longThe slotCount to set. |
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
setState(CapacityCommitment.State value)
public CapacityCommitment.Builder setState(CapacityCommitment.State value)Output only. State of the commitment.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | CapacityCommitment.StateThe state to set. |
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
setStateValue(int value)
public CapacityCommitment.Builder setStateValue(int value)Output only. State of the commitment.
.google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | intThe enum numeric value on the wire for state to set. |
| Type | Description |
| CapacityCommitment.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CapacityCommitment.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| CapacityCommitment.Builder |