Class CapacityCommitment.Builder (2.56.0) 

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CapacityCommitment.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CapacityCommitment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CapacityCommitment.Builder
Overrides

build()

public CapacityCommitment build()
Returns
Type Description
CapacityCommitment

buildPartial()

public CapacityCommitment buildPartial()
Returns
Type Description
CapacityCommitment

clear()

public CapacityCommitment.Builder clear()
Returns
Type Description
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. 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
CapacityCommitment.Builder

clearCommitmentStartTime()

public CapacityCommitment.Builder clearCommitmentStartTime()

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
CapacityCommitment.Builder

clearEdition()

public CapacityCommitment.Builder clearEdition()

Edition of the capacity commitment.

.google.cloud.bigquery.reservation.v1.Edition edition = 12;

Returns
Type Description
CapacityCommitment.Builder

This builder for chaining.

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
Type Description
CapacityCommitment.Builder

clearField(Descriptors.FieldDescriptor field)

public CapacityCommitment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CapacityCommitment.Builder
Overrides

clearIsFlatRate()

public CapacityCommitment.Builder clearIsFlatRate()

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
CapacityCommitment.Builder

This builder for chaining.

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.

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
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
Type Description
CapacityCommitment.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CapacityCommitment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CapacityCommitment.Builder
Overrides

clearPlan()

public CapacityCommitment.Builder clearPlan()

Capacity commitment commitment plan.

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

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

Returns
Type Description
CapacityCommitment.Builder

This builder for chaining.

clearSlotCount()

public CapacityCommitment.Builder clearSlotCount()

Number of slots in this commitment.

int64 slot_count = 2;

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

Returns
Type Description
CapacityCommitment.Builder

This builder for chaining.

clone()

public CapacityCommitment.Builder clone()
Returns
Type Description
CapacityCommitment.Builder
Overrides

getCommitmentEndTime()

public 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.

getCommitmentEndTimeBuilder()

public Timestamp.Builder getCommitmentEndTimeBuilder()

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
Builder

getCommitmentEndTimeOrBuilder()

public 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 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.

getCommitmentStartTimeBuilder()

public Timestamp.Builder getCommitmentStartTimeBuilder()

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
Builder

getCommitmentStartTimeOrBuilder()

public 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

getDefaultInstanceForType()

public CapacityCommitment getDefaultInstanceForType()
Returns
Type Description
CapacityCommitment

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEdition()

public Edition getEdition()

Edition of the capacity commitment.

.google.cloud.bigquery.reservation.v1.Edition edition = 12;

Returns
Type Description
Edition

The edition.

getEditionValue()

public 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 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.

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

Returns
Type Description
com.google.rpc.StatusOrBuilder

getIsFlatRate()

public 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 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 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 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 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 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 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 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 long getSlotCount()

Number of slots in this commitment.

int64 slot_count = 2;

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

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

Returns
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. 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
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. 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];

Parameter
Name Description
value Timestamp
Returns
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. 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];

Parameter
Name Description
value Timestamp
Returns
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];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
CapacityCommitment.Builder

mergeFrom(CapacityCommitment other)

public CapacityCommitment.Builder mergeFrom(CapacityCommitment other)
Parameter
Name Description
other CapacityCommitment
Returns
Type Description
CapacityCommitment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CapacityCommitment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CapacityCommitment.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CapacityCommitment.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CapacityCommitment.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CapacityCommitment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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. 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];

Parameter
Name Description
value Timestamp
Returns
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. 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];

Parameter
Name Description
builderForValue Builder
Returns
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. 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];

Parameter
Name Description
value Timestamp
Returns
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. 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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CapacityCommitment.Builder

setEdition(Edition value)

public CapacityCommitment.Builder setEdition(Edition value)

Edition of the capacity commitment.

.google.cloud.bigquery.reservation.v1.Edition edition = 12;

Parameter
Name Description
value Edition

The edition to set.
Returns
Type Description
CapacityCommitment.Builder

This builder for chaining.

setEditionValue(int value)

public CapacityCommitment.Builder setEditionValue(int value)

Edition of the capacity commitment.

.google.cloud.bigquery.reservation.v1.Edition edition = 12;

Parameter
Name Description
value int

The enum numeric value on the wire for edition to set.
Returns
Type Description
CapacityCommitment.Builder

This builder for chaining.

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
Name Description
value com.google.rpc.Status
Returns
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];

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
CapacityCommitment.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CapacityCommitment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CapacityCommitment.Builder
Overrides

setIsFlatRate(boolean value)

public CapacityCommitment.Builder setIsFlatRate(boolean value)

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

Parameter
Name Description
value boolean

The isFlatRate to set.
Returns
Type Description
CapacityCommitment.Builder

This builder for chaining.

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.

NOTE: this is a preview feature. Project must be allow-listed in order to set this field.

bool multi_region_auxiliary = 10;

Parameter
Name Description
value boolean

The multiRegionAuxiliary to set.
Returns
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];

Parameter
Name Description
value String

The name to set.
Returns
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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
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;

Parameter
Name Description
value CapacityCommitment.CommitmentPlan

The plan to set.
Returns
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;

Parameter
Name Description
value int

The enum numeric value on the wire for plan to set.
Returns
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;

Parameter
Name Description
value CapacityCommitment.CommitmentPlan

The renewalPlan to set.
Returns
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;

Parameter
Name Description
value int

The enum numeric value on the wire for renewalPlan to set.
Returns
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)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CapacityCommitment.Builder
Overrides

setSlotCount(long value)

public CapacityCommitment.Builder setSlotCount(long value)

Number of slots in this commitment.

int64 slot_count = 2;

Parameter
Name Description
value long

The slotCount to set.
Returns
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];

Parameter
Name Description
value CapacityCommitment.State

The state to set.
Returns
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];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
CapacityCommitment.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CapacityCommitment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CapacityCommitment.Builder
Overrides