Class CapacityCommitment (2.55.0)

public final class CapacityCommitment extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CapacityCommitment

Implements

CapacityCommitmentOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

COMMITMENT_END_TIME_FIELD_NUMBER

public static final int COMMITMENT_END_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

COMMITMENT_START_TIME_FIELD_NUMBER

public static final int COMMITMENT_START_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

EDITION_FIELD_NUMBER

public static final int EDITION_FIELD_NUMBER

Field Value
Type	Description
`int`

FAILURE_STATUS_FIELD_NUMBER

public static final int FAILURE_STATUS_FIELD_NUMBER

Field Value
Type	Description
`int`

MULTI_REGION_AUXILIARY_FIELD_NUMBER

public static final int MULTI_REGION_AUXILIARY_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

PLAN_FIELD_NUMBER

public static final int PLAN_FIELD_NUMBER

Field Value
Type	Description
`int`

RENEWAL_PLAN_FIELD_NUMBER

public static final int RENEWAL_PLAN_FIELD_NUMBER

Field Value
Type	Description
`int`

SLOT_COUNT_FIELD_NUMBER

public static final int SLOT_COUNT_FIELD_NUMBER

Field Value
Type	Description
`int`

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static CapacityCommitment getDefaultInstance()

Returns
Type	Description
`CapacityCommitment`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static CapacityCommitment.Builder newBuilder()

Returns
Type	Description
`CapacityCommitment.Builder`

newBuilder(CapacityCommitment prototype)

public static CapacityCommitment.Builder newBuilder(CapacityCommitment prototype)

Parameter
Name	Description
`prototype`	`CapacityCommitment`

Returns
Type	Description
`CapacityCommitment.Builder`

parseDelimitedFrom(InputStream input)

public static CapacityCommitment parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CapacityCommitment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static CapacityCommitment parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CapacityCommitment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static CapacityCommitment parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CapacityCommitment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static CapacityCommitment parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CapacityCommitment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static CapacityCommitment parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CapacityCommitment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static CapacityCommitment parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CapacityCommitment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CapacityCommitment`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<CapacityCommitment> parser()

Returns
Type	Description
`Parser<CapacityCommitment>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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
Type	Description
`Timestamp`	The commitmentEndTime.

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

Returns
Type	Description
`Timestamp`	The commitmentStartTime.

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
Type	Description
`TimestampOrBuilder`

getDefaultInstanceForType()

public CapacityCommitment getDefaultInstanceForType()

Returns
Type	Description
`CapacityCommitment`

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.

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`

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()

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for name.

getParserForType()

public Parser<CapacityCommitment> getParserForType()

Returns
Type	Description
`Parser<CapacityCommitment>`

Overrides

GeneratedMessageV3.getParserForType()

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()

.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan renewal_plan = 8;

Returns
Type	Description
`int`	The enum numeric value on the wire for renewalPlan.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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.

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

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

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CapacityCommitment.Builder newBuilderForType()

Returns
Type	Description
`CapacityCommitment.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CapacityCommitment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`CapacityCommitment.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CapacityCommitment.Builder toBuilder()

Returns
Type	Description
`CapacityCommitment.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`