- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CommitmentImplements
CommitmentOrBuilderStatic Fields
CATEGORY_FIELD_NUMBER
public static final int CATEGORY_FIELD_NUMBER
Type | Description |
int |
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Type | Description |
int |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Type | Description |
int |
END_TIMESTAMP_FIELD_NUMBER
public static final int END_TIMESTAMP_FIELD_NUMBER
Type | Description |
int |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Type | Description |
int |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Type | Description |
int |
LICENSE_RESOURCE_FIELD_NUMBER
public static final int LICENSE_RESOURCE_FIELD_NUMBER
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Type | Description |
int |
PLAN_FIELD_NUMBER
public static final int PLAN_FIELD_NUMBER
Type | Description |
int |
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
Type | Description |
int |
RESERVATIONS_FIELD_NUMBER
public static final int RESERVATIONS_FIELD_NUMBER
Type | Description |
int |
RESOURCES_FIELD_NUMBER
public static final int RESOURCES_FIELD_NUMBER
Type | Description |
int |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
Type | Description |
int |
START_TIMESTAMP_FIELD_NUMBER
public static final int START_TIMESTAMP_FIELD_NUMBER
Type | Description |
int |
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
Type | Description |
int |
STATUS_MESSAGE_FIELD_NUMBER
public static final int STATUS_MESSAGE_FIELD_NUMBER
Type | Description |
int |
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Type | Description |
int |
Static Methods
getDefaultInstance()
public static Commitment getDefaultInstance()
Type | Description |
Commitment |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
newBuilder()
public static Commitment.Builder newBuilder()
Type | Description |
Commitment.Builder |
newBuilder(Commitment prototype)
public static Commitment.Builder newBuilder(Commitment prototype)
Name | Description |
prototype | Commitment |
Type | Description |
Commitment.Builder |
parseDelimitedFrom(InputStream input)
public static Commitment parseDelimitedFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
Commitment |
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Commitment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Commitment |
Type | Description |
IOException |
parseFrom(byte[] data)
public static Commitment parseFrom(byte[] data)
Name | Description |
data | byte[] |
Type | Description |
Commitment |
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Commitment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Commitment |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Commitment parseFrom(ByteString data)
Name | Description |
data | ByteString |
Type | Description |
Commitment |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Commitment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Commitment |
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Commitment parseFrom(CodedInputStream input)
Name | Description |
input | CodedInputStream |
Type | Description |
Commitment |
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Commitment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Commitment |
Type | Description |
IOException |
parseFrom(InputStream input)
public static Commitment parseFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
Commitment |
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Commitment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Commitment |
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static Commitment parseFrom(ByteBuffer data)
Name | Description |
data | ByteBuffer |
Type | Description |
Commitment |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Commitment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Commitment |
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<Commitment> parser()
Type | Description |
Parser<Commitment> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Name | Description |
obj | Object |
Type | Description |
boolean |
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;
Type | Description |
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;
Type | Description |
ByteString | The bytes for category. |
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public Commitment getDefaultInstanceForType()
Type | Description |
Commitment |
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Type | Description |
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;
Type | Description |
ByteString | The bytes for description. |
getEndTimestamp()
public String getEndTimestamp()
[Output Only] Commitment end time in RFC3339 text format.
optional string end_timestamp = 468096690;
Type | Description |
String | The endTimestamp. |
getEndTimestampBytes()
public ByteString getEndTimestampBytes()
[Output Only] Commitment end time in RFC3339 text format.
optional string end_timestamp = 468096690;
Type | Description |
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;
Type | Description |
long | The id. |
getKind()
public String getKind()
[Output Only] Type of the resource. Always compute#commitment for commitments.
optional string kind = 3292052;
Type | Description |
String | The kind. |
getKindBytes()
public ByteString getKindBytes()
[Output Only] Type of the resource. Always compute#commitment for commitments.
optional string kind = 3292052;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
ByteString | The bytes for name. |
getParserForType()
public Parser<Commitment> getParserForType()
Type | Description |
Parser<Commitment> |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
String | The region. |
getRegionBytes()
public ByteString getRegionBytes()
[Output Only] URL of the region where this commitment may be used.
optional string region = 138946292;
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
Reservation |
getReservationsCount()
public int getReservationsCount()
List of reservations in this commitment.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Type | Description |
int |
getReservationsList()
public List<Reservation> getReservationsList()
List of reservations in this commitment.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Type | Description |
List<Reservation> |
getReservationsOrBuilder(int index)
public ReservationOrBuilder getReservationsOrBuilder(int index)
List of reservations in this commitment.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Name | Description |
index | int |
Type | Description |
ReservationOrBuilder |
getReservationsOrBuilderList()
public List<? extends ReservationOrBuilder> getReservationsOrBuilderList()
List of reservations in this commitment.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
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;
Type | Description |
List<? extends com.google.cloud.compute.v1.ResourceCommitmentOrBuilder> |
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
ByteString | The bytes for selfLink. |
getSerializedSize()
public int getSerializedSize()
Type | Description |
int |
getStartTimestamp()
public String getStartTimestamp()
[Output Only] Commitment start time in RFC3339 text format.
optional string start_timestamp = 83645817;
Type | Description |
String | The startTimestamp. |
getStartTimestampBytes()
public ByteString getStartTimestampBytes()
[Output Only] Commitment start time in RFC3339 text format.
optional string start_timestamp = 83645817;
Type | Description |
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;
Type | Description |
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;
Type | Description |
ByteString | The bytes for status. |
getStatusMessage()
public String getStatusMessage()
[Output Only] An optional, human-readable explanation of the status.
optional string status_message = 297428154;
Type | Description |
String | The statusMessage. |
getStatusMessageBytes()
public ByteString getStatusMessageBytes()
[Output Only] An optional, human-readable explanation of the status.
optional string status_message = 297428154;
Type | Description |
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;
Type | Description |
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;
Type | Description |
ByteString | The bytes for type. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Type | Description |
UnknownFieldSet |
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;
Type | Description |
boolean | Whether the category field is set. |
hasCreationTimestamp()
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
boolean | Whether the region field is set. |
hasSelfLink()
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
boolean | Whether the type field is set. |
hashCode()
public int hashCode()
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
newBuilderForType()
public Commitment.Builder newBuilderForType()
Type | Description |
Commitment.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Commitment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Name | Description |
parent | BuilderParent |
Type | Description |
Commitment.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Name | Description |
unused | UnusedPrivateParameter |
Type | Description |
Object |
toBuilder()
public Commitment.Builder toBuilder()
Type | Description |
Commitment.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Name | Description |
output | CodedOutputStream |
Type | Description |
IOException |