Class Commitment (1.12.0)

public final class Commitment extends GeneratedMessageV3 implements CommitmentOrBuilder

Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.

Protobuf type google.cloud.compute.v1.Commitment

Implements

CommitmentOrBuilder

Static Fields

AUTO_RENEW_FIELD_NUMBER

public static final int AUTO_RENEW_FIELD_NUMBER
Field Value
TypeDescription
int

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
TypeDescription
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIMESTAMP_FIELD_NUMBER

public static final int END_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

LICENSE_RESOURCE_FIELD_NUMBER

public static final int LICENSE_RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PLAN_FIELD_NUMBER

public static final int PLAN_FIELD_NUMBER
Field Value
TypeDescription
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
TypeDescription
int

RESERVATIONS_FIELD_NUMBER

public static final int RESERVATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCES_FIELD_NUMBER

public static final int RESOURCES_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIMESTAMP_FIELD_NUMBER

public static final int START_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_MESSAGE_FIELD_NUMBER

public static final int STATUS_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Commitment getDefaultInstance()
Returns
TypeDescription
Commitment

getDescriptor()

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

newBuilder()

public static Commitment.Builder newBuilder()
Returns
TypeDescription
Commitment.Builder

newBuilder(Commitment prototype)

public static Commitment.Builder newBuilder(Commitment prototype)
Parameter
NameDescription
prototypeCommitment
Returns
TypeDescription
Commitment.Builder

parseDelimitedFrom(InputStream input)

public static Commitment parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Commitment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Commitment parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Commitment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Commitment parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Commitment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Commitment parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Commitment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Commitment parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Commitment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Commitment parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Commitment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Commitment
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Commitment> parser()
Returns
TypeDescription
Parser<Commitment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAutoRenew()

public boolean getAutoRenew()

Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.

optional bool auto_renew = 495520765;

Returns
TypeDescription
boolean

The autoRenew.

getCategory()

public String getCategory()

The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. Check the Category enum for the list of possible values.

optional string category = 50511102;

Returns
TypeDescription
String

The category.

getCategoryBytes()

public ByteString getCategoryBytes()

The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. Check the Category enum for the list of possible values.

optional string category = 50511102;

Returns
TypeDescription
ByteString

The bytes for category.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public Commitment getDefaultInstanceForType()
Returns
TypeDescription
Commitment

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getEndTimestamp()

public String getEndTimestamp()

[Output Only] Commitment end time in RFC3339 text format.

optional string end_timestamp = 468096690;

Returns
TypeDescription
String

The endTimestamp.

getEndTimestampBytes()

public ByteString getEndTimestampBytes()

[Output Only] Commitment end time in RFC3339 text format.

optional string end_timestamp = 468096690;

Returns
TypeDescription
ByteString

The bytes for endTimestamp.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#commitment for commitments.

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#commitment for commitments.

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getLicenseResource()

public LicenseResourceCommitment getLicenseResource()

The license specification required as part of a license commitment.

optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;

Returns
TypeDescription
LicenseResourceCommitment

The licenseResource.

getLicenseResourceOrBuilder()

public LicenseResourceCommitmentOrBuilder getLicenseResourceOrBuilder()

The license specification required as part of a license commitment.

optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;

Returns
TypeDescription
LicenseResourceCommitmentOrBuilder

getName()

public String getName()

Name of the resource. Provided by the client when the resource is created. 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? 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;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the resource. Provided by the client when the resource is created. 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? 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;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Commitment> getParserForType()
Returns
TypeDescription
Parser<Commitment>
Overrides

getPlan()

public String getPlan()

The plan for this commitment, which determines duration and discount rate. The currently supported plans 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;

Returns
TypeDescription
String

The plan.

getPlanBytes()

public ByteString getPlanBytes()

The plan for this commitment, which determines duration and discount rate. The currently supported plans 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;

Returns
TypeDescription
ByteString

The bytes for plan.

getRegion()

public String getRegion()

[Output Only] URL of the region where this commitment may be used.

optional string region = 138946292;

Returns
TypeDescription
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

[Output Only] URL of the region where this commitment may be used.

optional string region = 138946292;

Returns
TypeDescription
ByteString

The bytes for region.

getReservations(int index)

public Reservation getReservations(int index)

List of reservations in this commitment.

repeated .google.cloud.compute.v1.Reservation reservations = 399717927;

Parameter
NameDescription
indexint
Returns
TypeDescription
Reservation

getReservationsCount()

public int getReservationsCount()

List of reservations in this commitment.

repeated .google.cloud.compute.v1.Reservation reservations = 399717927;

Returns
TypeDescription
int

getReservationsList()

public List<Reservation> getReservationsList()

List of reservations in this commitment.

repeated .google.cloud.compute.v1.Reservation reservations = 399717927;

Returns
TypeDescription
List<Reservation>

getReservationsOrBuilder(int index)

public ReservationOrBuilder getReservationsOrBuilder(int index)

List of reservations in this commitment.

repeated .google.cloud.compute.v1.Reservation reservations = 399717927;

Parameter
NameDescription
indexint
Returns
TypeDescription
ReservationOrBuilder

getReservationsOrBuilderList()

public List<? extends ReservationOrBuilder> getReservationsOrBuilderList()

List of reservations in this commitment.

repeated .google.cloud.compute.v1.Reservation reservations = 399717927;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.ReservationOrBuilder>

getResources(int index)

public ResourceCommitment getResources(int index)

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;

Parameter
NameDescription
indexint
Returns
TypeDescription
ResourceCommitment

getResourcesCount()

public int getResourcesCount()

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;

Returns
TypeDescription
int

getResourcesList()

public List<ResourceCommitment> getResourcesList()

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;

Returns
TypeDescription
List<ResourceCommitment>

getResourcesOrBuilder(int index)

public ResourceCommitmentOrBuilder getResourcesOrBuilder(int index)

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;

Parameter
NameDescription
indexint
Returns
TypeDescription
ResourceCommitmentOrBuilder

getResourcesOrBuilderList()

public List<? extends ResourceCommitmentOrBuilder> getResourcesOrBuilderList()

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.ResourceCommitmentOrBuilder>
public String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTimestamp()

public String getStartTimestamp()

[Output Only] Commitment start time in RFC3339 text format.

optional string start_timestamp = 83645817;

Returns
TypeDescription
String

The startTimestamp.

getStartTimestampBytes()

public ByteString getStartTimestampBytes()

[Output Only] Commitment start time in RFC3339 text format.

optional string start_timestamp = 83645817;

Returns
TypeDescription
ByteString

The bytes for startTimestamp.

getStatus()

public String getStatus()

[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
TypeDescription
String

The status.

getStatusBytes()

public ByteString getStatusBytes()

[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
TypeDescription
ByteString

The bytes for status.

getStatusMessage()

public String getStatusMessage()

[Output Only] An optional, human-readable explanation of the status.

optional string status_message = 297428154;

Returns
TypeDescription
String

The statusMessage.

getStatusMessageBytes()

public ByteString getStatusMessageBytes()

[Output Only] An optional, human-readable explanation of the status.

optional string status_message = 297428154;

Returns
TypeDescription
ByteString

The bytes for statusMessage.

getType()

public String getType()

The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
TypeDescription
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
TypeDescription
ByteString

The bytes for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasAutoRenew()

public boolean hasAutoRenew()

Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.

optional bool auto_renew = 495520765;

Returns
TypeDescription
boolean

Whether the autoRenew field is set.

hasCategory()

public boolean hasCategory()

The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. Check the Category enum for the list of possible values.

optional string category = 50511102;

Returns
TypeDescription
boolean

Whether the category field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasEndTimestamp()

public boolean hasEndTimestamp()

[Output Only] Commitment end time in RFC3339 text format.

optional string end_timestamp = 468096690;

Returns
TypeDescription
boolean

Whether the endTimestamp field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#commitment for commitments.

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

hasLicenseResource()

public boolean hasLicenseResource()

The license specification required as part of a license commitment.

optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;

Returns
TypeDescription
boolean

Whether the licenseResource field is set.

hasName()

public boolean hasName()

Name of the resource. Provided by the client when the resource is created. 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? 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;

Returns
TypeDescription
boolean

Whether the name field is set.

hasPlan()

public boolean hasPlan()

The plan for this commitment, which determines duration and discount rate. The currently supported plans 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;

Returns
TypeDescription
boolean

Whether the plan field is set.

hasRegion()

public boolean hasRegion()

[Output Only] URL of the region where this commitment may be used.

optional string region = 138946292;

Returns
TypeDescription
boolean

Whether the region field is set.

public boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hasStartTimestamp()

public boolean hasStartTimestamp()

[Output Only] Commitment start time in RFC3339 text format.

optional string start_timestamp = 83645817;

Returns
TypeDescription
boolean

Whether the startTimestamp field is set.

hasStatus()

public boolean hasStatus()

[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
TypeDescription
boolean

Whether the status field is set.

hasStatusMessage()

public boolean hasStatusMessage()

[Output Only] An optional, human-readable explanation of the status.

optional string status_message = 297428154;

Returns
TypeDescription
boolean

Whether the statusMessage field is set.

hasType()

public boolean hasType()

The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
TypeDescription
boolean

Whether the type field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Commitment.Builder newBuilderForType()
Returns
TypeDescription
Commitment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Commitment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Commitment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Commitment.Builder toBuilder()
Returns
TypeDescription
Commitment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException