Class CapacityCommitment.Builder (2.3.1)

public static final class CapacityCommitment.Builder extends GeneratedMessageV3.Builder<CapacityCommitment.Builder> implements CapacityCommitmentOrBuilder

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.

Protobuf type google.cloud.bigquery.reservation.v1.CapacityCommitment

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CapacityCommitment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CapacityCommitment.Builder
Overrides

build()

public CapacityCommitment build()
Returns
TypeDescription
CapacityCommitment

buildPartial()

public CapacityCommitment buildPartial()
Returns
TypeDescription
CapacityCommitment

clear()

public CapacityCommitment.Builder clear()
Returns
TypeDescription
CapacityCommitment.Builder
Overrides

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];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
CapacityCommitment.Builder

clearField(Descriptors.FieldDescriptor field)

public CapacityCommitment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CapacityCommitment.Builder
Overrides

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;

Returns
TypeDescription
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];

Returns
TypeDescription
CapacityCommitment.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CapacityCommitment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CapacityCommitment.Builder
Overrides

clearPlan()

public CapacityCommitment.Builder clearPlan()

Capacity commitment commitment plan.

.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;

Returns
TypeDescription
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;

Returns
TypeDescription
CapacityCommitment.Builder

This builder for chaining.

clearSlotCount()

public CapacityCommitment.Builder clearSlotCount()

Number of slots in this commitment.

int64 slot_count = 2;

Returns
TypeDescription
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];

Returns
TypeDescription
CapacityCommitment.Builder

This builder for chaining.

clone()

public CapacityCommitment.Builder clone()
Returns
TypeDescription
CapacityCommitment.Builder
Overrides

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];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public CapacityCommitment getDefaultInstanceForType()
Returns
TypeDescription
CapacityCommitment

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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;

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
ByteString

The bytes for name.

getPlan()

public CapacityCommitment.CommitmentPlan getPlan()

Capacity commitment commitment plan.

.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;

Returns
TypeDescription
CapacityCommitment.CommitmentPlan

The plan.

getPlanValue()

public int getPlanValue()

Capacity commitment commitment plan.

.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
int

The enum numeric value on the wire for renewalPlan.

getSlotCount()

public long getSlotCount()

Number of slots in this commitment.

int64 slot_count = 2;

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
boolean

Whether the failureStatus field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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];

Parameter
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
CapacityCommitment.Builder

mergeFrom(CapacityCommitment other)

public CapacityCommitment.Builder mergeFrom(CapacityCommitment other)
Parameter
NameDescription
otherCapacityCommitment
Returns
TypeDescription
CapacityCommitment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CapacityCommitment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CapacityCommitment.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CapacityCommitment.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CapacityCommitment.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CapacityCommitment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CapacityCommitment.Builder
Overrides

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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
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];

Parameter
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
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];

Parameter
NameDescription
builderForValuecom.google.rpc.Status.Builder
Returns
TypeDescription
CapacityCommitment.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CapacityCommitment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CapacityCommitment.Builder
Overrides

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;

Parameter
NameDescription
valueboolean

The multiRegionAuxiliary to set.

Returns
TypeDescription
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];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
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];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueCapacityCommitment.CommitmentPlan

The plan to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueint

The enum numeric value on the wire for plan to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueCapacityCommitment.CommitmentPlan

The renewalPlan to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueint

The enum numeric value on the wire for renewalPlan to set.

Returns
TypeDescription
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)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CapacityCommitment.Builder
Overrides

setSlotCount(long value)

public CapacityCommitment.Builder setSlotCount(long value)

Number of slots in this commitment.

int64 slot_count = 2;

Parameter
NameDescription
valuelong

The slotCount to set.

Returns
TypeDescription
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];

Parameter
NameDescription
valueCapacityCommitment.State

The state to set.

Returns
TypeDescription
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];

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
CapacityCommitment.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CapacityCommitment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CapacityCommitment.Builder
Overrides