public final class Commitment extends com.google.protobuf.GeneratedMessageV3 implements CommitmentOrBuilder
Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discountsProtobuf type
google.cloud.compute.v1.Commitment| Modifier and Type | Class and Description |
|---|---|
static class |
Commitment.Builder
Represents a regional resource-based commitment resource.
|
static class |
Commitment.Category
The category of the commitment; specifies whether the commitment is for hardware or software resources.
|
static class |
Commitment.Plan
The minimum time duration that you commit to purchasing resources.
|
static class |
Commitment.Status
[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined).
|
static class |
Commitment.Type
The type of commitment; specifies the machine series for which you want to commit to purchasing resources.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
AUTO_RENEW_FIELD_NUMBER |
static int |
CATEGORY_FIELD_NUMBER |
static int |
CREATION_TIMESTAMP_FIELD_NUMBER |
static int |
CUSTOM_END_TIMESTAMP_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
END_TIMESTAMP_FIELD_NUMBER |
static int |
EXISTING_RESERVATIONS_FIELD_NUMBER |
static int |
ID_FIELD_NUMBER |
static int |
KIND_FIELD_NUMBER |
static int |
LICENSE_RESOURCE_FIELD_NUMBER |
static int |
MERGE_SOURCE_COMMITMENTS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PLAN_FIELD_NUMBER |
static int |
REGION_FIELD_NUMBER |
static int |
RESERVATIONS_FIELD_NUMBER |
static int |
RESOURCE_STATUS_FIELD_NUMBER |
static int |
RESOURCES_FIELD_NUMBER |
static int |
SELF_LINK_FIELD_NUMBER |
static int |
SPLIT_SOURCE_COMMITMENT_FIELD_NUMBER |
static int |
START_TIMESTAMP_FIELD_NUMBER |
static int |
STATUS_FIELD_NUMBER |
static int |
STATUS_MESSAGE_FIELD_NUMBER |
static int |
TYPE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
boolean |
getAutoRenew()
Specifies whether to automatically renew the commitment at the end of its current term.
|
String |
getCategory()
The category of the commitment; specifies whether the commitment is for hardware or software resources.
|
com.google.protobuf.ByteString |
getCategoryBytes()
The category of the commitment; specifies whether the commitment is for hardware or software resources.
|
String |
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
|
com.google.protobuf.ByteString |
getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
|
String |
getCustomEndTimestamp()
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format.
|
com.google.protobuf.ByteString |
getCustomEndTimestampBytes()
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format.
|
static Commitment |
getDefaultInstance() |
Commitment |
getDefaultInstanceForType() |
String |
getDescription()
An optional description of the commitment.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
An optional description of the commitment.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getEndTimestamp()
[Output Only] Commitment end time in RFC3339 text format.
|
com.google.protobuf.ByteString |
getEndTimestampBytes()
[Output Only] Commitment end time in RFC3339 text format.
|
String |
getExistingReservations(int index)
repeated string existing_reservations = 493028443; |
com.google.protobuf.ByteString |
getExistingReservationsBytes(int index)
repeated string existing_reservations = 493028443; |
int |
getExistingReservationsCount()
repeated string existing_reservations = 493028443; |
com.google.protobuf.ProtocolStringList |
getExistingReservationsList()
repeated string existing_reservations = 493028443; |
long |
getId()
[Output Only] The unique identifier for the resource.
|
String |
getKind()
[Output Only] Type of the resource.
|
com.google.protobuf.ByteString |
getKindBytes()
[Output Only] Type of the resource.
|
LicenseResourceCommitment |
getLicenseResource()
The license specification required as part of a license commitment.
|
LicenseResourceCommitmentOrBuilder |
getLicenseResourceOrBuilder()
The license specification required as part of a license commitment.
|
String |
getMergeSourceCommitments(int index)
The list of source commitments that you are merging to create the new merged commitment.
|
com.google.protobuf.ByteString |
getMergeSourceCommitmentsBytes(int index)
The list of source commitments that you are merging to create the new merged commitment.
|
int |
getMergeSourceCommitmentsCount()
The list of source commitments that you are merging to create the new merged commitment.
|
com.google.protobuf.ProtocolStringList |
getMergeSourceCommitmentsList()
The list of source commitments that you are merging to create the new merged commitment.
|
String |
getName()
Name of the commitment.
|
com.google.protobuf.ByteString |
getNameBytes()
Name of the commitment.
|
com.google.protobuf.Parser<Commitment> |
getParserForType() |
String |
getPlan()
The minimum time duration that you commit to purchasing resources.
|
com.google.protobuf.ByteString |
getPlanBytes()
The minimum time duration that you commit to purchasing resources.
|
String |
getRegion()
[Output Only] URL of the region where the commitment and committed resources are located.
|
com.google.protobuf.ByteString |
getRegionBytes()
[Output Only] URL of the region where the commitment and committed resources are located.
|
Reservation |
getReservations(int index)
The list of new reservations that you want to create and attach to this commitment.
|
int |
getReservationsCount()
The list of new reservations that you want to create and attach to this commitment.
|
List<Reservation> |
getReservationsList()
The list of new reservations that you want to create and attach to this commitment.
|
ReservationOrBuilder |
getReservationsOrBuilder(int index)
The list of new reservations that you want to create and attach to this commitment.
|
List<? extends ReservationOrBuilder> |
getReservationsOrBuilderList()
The list of new reservations that you want to create and attach to this commitment.
|
ResourceCommitment |
getResources(int index)
The list of all the hardware resources, with their types and amounts, that you want to commit to.
|
int |
getResourcesCount()
The list of all the hardware resources, with their types and amounts, that you want to commit to.
|
List<ResourceCommitment> |
getResourcesList()
The list of all the hardware resources, with their types and amounts, that you want to commit to.
|
ResourceCommitmentOrBuilder |
getResourcesOrBuilder(int index)
The list of all the hardware resources, with their types and amounts, that you want to commit to.
|
List<? extends ResourceCommitmentOrBuilder> |
getResourcesOrBuilderList()
The list of all the hardware resources, with their types and amounts, that you want to commit to.
|
CommitmentResourceStatus |
getResourceStatus()
[Output Only] Status information for Commitment resource.
|
CommitmentResourceStatusOrBuilder |
getResourceStatusOrBuilder()
[Output Only] Status information for Commitment resource.
|
String |
getSelfLink()
[Output Only] Server-defined URL for the resource.
|
com.google.protobuf.ByteString |
getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
|
int |
getSerializedSize() |
String |
getSplitSourceCommitment()
The source commitment from which you are transferring resources to create the new split commitment.
|
com.google.protobuf.ByteString |
getSplitSourceCommitmentBytes()
The source commitment from which you are transferring resources to create the new split commitment.
|
String |
getStartTimestamp()
[Output Only] Commitment start time in RFC3339 text format.
|
com.google.protobuf.ByteString |
getStartTimestampBytes()
[Output Only] Commitment start time in RFC3339 text format.
|
String |
getStatus()
[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined).
|
com.google.protobuf.ByteString |
getStatusBytes()
[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined).
|
String |
getStatusMessage()
[Output Only] An optional, human-readable explanation of the status.
|
com.google.protobuf.ByteString |
getStatusMessageBytes()
[Output Only] An optional, human-readable explanation of the status.
|
String |
getType()
The type of commitment; specifies the machine series for which you want to commit to purchasing resources.
|
com.google.protobuf.ByteString |
getTypeBytes()
The type of commitment; specifies the machine series for which you want to commit to purchasing resources.
|
boolean |
hasAutoRenew()
Specifies whether to automatically renew the commitment at the end of its current term.
|
boolean |
hasCategory()
The category of the commitment; specifies whether the commitment is for hardware or software resources.
|
boolean |
hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
|
boolean |
hasCustomEndTimestamp()
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format.
|
boolean |
hasDescription()
An optional description of the commitment.
|
boolean |
hasEndTimestamp()
[Output Only] Commitment end time in RFC3339 text format.
|
int |
hashCode() |
boolean |
hasId()
[Output Only] The unique identifier for the resource.
|
boolean |
hasKind()
[Output Only] Type of the resource.
|
boolean |
hasLicenseResource()
The license specification required as part of a license commitment.
|
boolean |
hasName()
Name of the commitment.
|
boolean |
hasPlan()
The minimum time duration that you commit to purchasing resources.
|
boolean |
hasRegion()
[Output Only] URL of the region where the commitment and committed resources are located.
|
boolean |
hasResourceStatus()
[Output Only] Status information for Commitment resource.
|
boolean |
hasSelfLink()
[Output Only] Server-defined URL for the resource.
|
boolean |
hasSplitSourceCommitment()
The source commitment from which you are transferring resources to create the new split commitment.
|
boolean |
hasStartTimestamp()
[Output Only] Commitment start time in RFC3339 text format.
|
boolean |
hasStatus()
[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined).
|
boolean |
hasStatusMessage()
[Output Only] An optional, human-readable explanation of the status.
|
boolean |
hasType()
The type of commitment; specifies the machine series for which you want to commit to purchasing resources.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Commitment.Builder |
newBuilder() |
static Commitment.Builder |
newBuilder(Commitment prototype) |
Commitment.Builder |
newBuilderForType() |
protected Commitment.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Commitment |
parseDelimitedFrom(InputStream input) |
static Commitment |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Commitment |
parseFrom(byte[] data) |
static Commitment |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Commitment |
parseFrom(ByteBuffer data) |
static Commitment |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Commitment |
parseFrom(com.google.protobuf.ByteString data) |
static Commitment |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Commitment |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Commitment |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Commitment |
parseFrom(InputStream input) |
static Commitment |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Commitment> |
parser() |
Commitment.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int AUTO_RENEW_FIELD_NUMBER
public static final int CATEGORY_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CUSTOM_END_TIMESTAMP_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int END_TIMESTAMP_FIELD_NUMBER
public static final int EXISTING_RESERVATIONS_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
public static final int LICENSE_RESOURCE_FIELD_NUMBER
public static final int MERGE_SOURCE_COMMITMENTS_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int PLAN_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
public static final int RESERVATIONS_FIELD_NUMBER
public static final int RESOURCE_STATUS_FIELD_NUMBER
public static final int RESOURCES_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
public static final int SPLIT_SOURCE_COMMITMENT_FIELD_NUMBER
public static final int START_TIMESTAMP_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
public static final int STATUS_MESSAGE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public boolean hasAutoRenew()
Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.
optional bool auto_renew = 495520765;hasAutoRenew in interface CommitmentOrBuilderpublic boolean getAutoRenew()
Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.
optional bool auto_renew = 495520765;getAutoRenew in interface CommitmentOrBuilderpublic boolean hasCategory()
The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. Check the Category enum for the list of possible values.
optional string category = 50511102;hasCategory in interface CommitmentOrBuilderpublic String getCategory()
The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. Check the Category enum for the list of possible values.
optional string category = 50511102;getCategory in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getCategoryBytes()
The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. Check the Category enum for the list of possible values.
optional string category = 50511102;getCategoryBytes in interface CommitmentOrBuilderpublic boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;hasCreationTimestamp in interface CommitmentOrBuilderpublic String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;getCreationTimestamp in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;getCreationTimestampBytes in interface CommitmentOrBuilderpublic boolean hasCustomEndTimestamp()
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
optional string custom_end_timestamp = 181770852;hasCustomEndTimestamp in interface CommitmentOrBuilderpublic String getCustomEndTimestamp()
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
optional string custom_end_timestamp = 181770852;getCustomEndTimestamp in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getCustomEndTimestampBytes()
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
optional string custom_end_timestamp = 181770852;getCustomEndTimestampBytes in interface CommitmentOrBuilderpublic boolean hasDescription()
An optional description of the commitment. You can provide this property when you create the resource.
optional string description = 422937596;hasDescription in interface CommitmentOrBuilderpublic String getDescription()
An optional description of the commitment. You can provide this property when you create the resource.
optional string description = 422937596;getDescription in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
An optional description of the commitment. You can provide this property when you create the resource.
optional string description = 422937596;getDescriptionBytes in interface CommitmentOrBuilderpublic boolean hasEndTimestamp()
[Output Only] Commitment end time in RFC3339 text format.
optional string end_timestamp = 468096690;hasEndTimestamp in interface CommitmentOrBuilderpublic String getEndTimestamp()
[Output Only] Commitment end time in RFC3339 text format.
optional string end_timestamp = 468096690;getEndTimestamp in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getEndTimestampBytes()
[Output Only] Commitment end time in RFC3339 text format.
optional string end_timestamp = 468096690;getEndTimestampBytes in interface CommitmentOrBuilderpublic com.google.protobuf.ProtocolStringList getExistingReservationsList()
repeated string existing_reservations = 493028443;getExistingReservationsList in interface CommitmentOrBuilderpublic int getExistingReservationsCount()
repeated string existing_reservations = 493028443;getExistingReservationsCount in interface CommitmentOrBuilderpublic String getExistingReservations(int index)
repeated string existing_reservations = 493028443;getExistingReservations in interface CommitmentOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getExistingReservationsBytes(int index)
repeated string existing_reservations = 493028443;getExistingReservationsBytes in interface CommitmentOrBuilderindex - The index of the value to return.public boolean hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;hasId in interface CommitmentOrBuilderpublic long getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;getId in interface CommitmentOrBuilderpublic boolean hasKind()
[Output Only] Type of the resource. Always compute#commitment for commitments.
optional string kind = 3292052;hasKind in interface CommitmentOrBuilderpublic String getKind()
[Output Only] Type of the resource. Always compute#commitment for commitments.
optional string kind = 3292052;getKind in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getKindBytes()
[Output Only] Type of the resource. Always compute#commitment for commitments.
optional string kind = 3292052;getKindBytes in interface CommitmentOrBuilderpublic boolean hasLicenseResource()
The license specification required as part of a license commitment.
optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;
hasLicenseResource in interface CommitmentOrBuilderpublic LicenseResourceCommitment getLicenseResource()
The license specification required as part of a license commitment.
optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;
getLicenseResource in interface CommitmentOrBuilderpublic LicenseResourceCommitmentOrBuilder getLicenseResourceOrBuilder()
The license specification required as part of a license commitment.
optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;
getLicenseResourceOrBuilder in interface CommitmentOrBuilderpublic com.google.protobuf.ProtocolStringList getMergeSourceCommitmentsList()
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;getMergeSourceCommitmentsList in interface CommitmentOrBuilderpublic int getMergeSourceCommitmentsCount()
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;getMergeSourceCommitmentsCount in interface CommitmentOrBuilderpublic String getMergeSourceCommitments(int index)
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;getMergeSourceCommitments in interface CommitmentOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getMergeSourceCommitmentsBytes(int index)
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;getMergeSourceCommitmentsBytes in interface CommitmentOrBuilderindex - The index of the value to return.public boolean hasName()
Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;hasName in interface CommitmentOrBuilderpublic String getName()
Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;getName in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;getNameBytes in interface CommitmentOrBuilderpublic boolean hasPlan()
The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Check the Plan enum for the list of possible values.
optional string plan = 3443497;hasPlan in interface CommitmentOrBuilderpublic String getPlan()
The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Check the Plan enum for the list of possible values.
optional string plan = 3443497;getPlan in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getPlanBytes()
The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Check the Plan enum for the list of possible values.
optional string plan = 3443497;getPlanBytes in interface CommitmentOrBuilderpublic boolean hasRegion()
[Output Only] URL of the region where the commitment and committed resources are located.
optional string region = 138946292;hasRegion in interface CommitmentOrBuilderpublic String getRegion()
[Output Only] URL of the region where the commitment and committed resources are located.
optional string region = 138946292;getRegion in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getRegionBytes()
[Output Only] URL of the region where the commitment and committed resources are located.
optional string region = 138946292;getRegionBytes in interface CommitmentOrBuilderpublic List<Reservation> getReservationsList()
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;getReservationsList in interface CommitmentOrBuilderpublic List<? extends ReservationOrBuilder> getReservationsOrBuilderList()
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;getReservationsOrBuilderList in interface CommitmentOrBuilderpublic int getReservationsCount()
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;getReservationsCount in interface CommitmentOrBuilderpublic Reservation getReservations(int index)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;getReservations in interface CommitmentOrBuilderpublic ReservationOrBuilder getReservationsOrBuilder(int index)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;getReservationsOrBuilder in interface CommitmentOrBuilderpublic boolean hasResourceStatus()
[Output Only] Status information for Commitment resource.
optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
hasResourceStatus in interface CommitmentOrBuilderpublic CommitmentResourceStatus getResourceStatus()
[Output Only] Status information for Commitment resource.
optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
getResourceStatus in interface CommitmentOrBuilderpublic CommitmentResourceStatusOrBuilder getResourceStatusOrBuilder()
[Output Only] Status information for Commitment resource.
optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
getResourceStatusOrBuilder in interface CommitmentOrBuilderpublic List<ResourceCommitment> getResourcesList()
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;getResourcesList in interface CommitmentOrBuilderpublic List<? extends ResourceCommitmentOrBuilder> getResourcesOrBuilderList()
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;getResourcesOrBuilderList in interface CommitmentOrBuilderpublic int getResourcesCount()
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;getResourcesCount in interface CommitmentOrBuilderpublic ResourceCommitment getResources(int index)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;getResources in interface CommitmentOrBuilderpublic ResourceCommitmentOrBuilder getResourcesOrBuilder(int index)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;getResourcesOrBuilder in interface CommitmentOrBuilderpublic boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;hasSelfLink in interface CommitmentOrBuilderpublic String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;getSelfLink in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;getSelfLinkBytes in interface CommitmentOrBuilderpublic boolean hasSplitSourceCommitment()
The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
optional string split_source_commitment = 402611156;hasSplitSourceCommitment in interface CommitmentOrBuilderpublic String getSplitSourceCommitment()
The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
optional string split_source_commitment = 402611156;getSplitSourceCommitment in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getSplitSourceCommitmentBytes()
The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
optional string split_source_commitment = 402611156;getSplitSourceCommitmentBytes in interface CommitmentOrBuilderpublic boolean hasStartTimestamp()
[Output Only] Commitment start time in RFC3339 text format.
optional string start_timestamp = 83645817;hasStartTimestamp in interface CommitmentOrBuilderpublic String getStartTimestamp()
[Output Only] Commitment start time in RFC3339 text format.
optional string start_timestamp = 83645817;getStartTimestamp in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getStartTimestampBytes()
[Output Only] Commitment start time in RFC3339 text format.
optional string start_timestamp = 83645817;getStartTimestampBytes in interface CommitmentOrBuilderpublic boolean hasStatus()
[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. Check the Status enum for the list of possible values.
optional string status = 181260274;hasStatus in interface CommitmentOrBuilderpublic String getStatus()
[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. Check the Status enum for the list of possible values.
optional string status = 181260274;getStatus in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getStatusBytes()
[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. Check the Status enum for the list of possible values.
optional string status = 181260274;getStatusBytes in interface CommitmentOrBuilderpublic boolean hasStatusMessage()
[Output Only] An optional, human-readable explanation of the status.
optional string status_message = 297428154;hasStatusMessage in interface CommitmentOrBuilderpublic String getStatusMessage()
[Output Only] An optional, human-readable explanation of the status.
optional string status_message = 297428154;getStatusMessage in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getStatusMessageBytes()
[Output Only] An optional, human-readable explanation of the status.
optional string status_message = 297428154;getStatusMessageBytes in interface CommitmentOrBuilderpublic boolean hasType()
The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. Check the Type enum for the list of possible values.
optional string type = 3575610;hasType in interface CommitmentOrBuilderpublic String getType()
The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. Check the Type enum for the list of possible values.
optional string type = 3575610;getType in interface CommitmentOrBuilderpublic com.google.protobuf.ByteString getTypeBytes()
The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. Check the Type enum for the list of possible values.
optional string type = 3575610;getTypeBytes in interface CommitmentOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Commitment parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Commitment parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Commitment parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Commitment parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Commitment parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Commitment parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Commitment parseFrom(InputStream input) throws IOException
IOExceptionpublic static Commitment parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Commitment parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Commitment parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Commitment parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Commitment parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Commitment.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Commitment.Builder newBuilder()
public static Commitment.Builder newBuilder(Commitment prototype)
public Commitment.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Commitment.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Commitment getDefaultInstance()
public static com.google.protobuf.Parser<Commitment> parser()
public com.google.protobuf.Parser<Commitment> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Commitment getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.