Interface CommitmentOrBuilder (1.46.0)

Version 1.46.0

• 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 interface CommitmentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutoRenew()

public abstract 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
Type	Description
boolean	The autoRenew.

getCategory()

public abstract 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
Type	Description
String	The category.

getCategoryBytes()

public abstract 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
Type	Description
ByteString	The bytes for category.

getCreationTimestamp()

public abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
String	The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
ByteString	The bytes for creationTimestamp.

getDescription()

public abstract String getDescription()

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

optional string description = 422937596;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
Type	Description
ByteString	The bytes for description.

getEndTimestamp()

public abstract String getEndTimestamp()

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

optional string end_timestamp = 468096690;

Returns
Type	Description
String	The endTimestamp.

getEndTimestampBytes()

public abstract ByteString getEndTimestampBytes()

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

optional string end_timestamp = 468096690;

Returns
Type	Description
ByteString	The bytes for endTimestamp.

getExistingReservations(int index)

public abstract String getExistingReservations(int index)

Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation

repeated string existing_reservations = 493028443;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The existingReservations at the given index.

getExistingReservationsBytes(int index)

public abstract ByteString getExistingReservationsBytes(int index)

Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation

repeated string existing_reservations = 493028443;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the existingReservations at the given index.

getExistingReservationsCount()

public abstract int getExistingReservationsCount()

Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation

repeated string existing_reservations = 493028443;

Returns
Type	Description
int	The count of existingReservations.

getExistingReservationsList()

public abstract List<String> getExistingReservationsList()

Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation

repeated string existing_reservations = 493028443;

Returns
Type	Description
List<String>	A list containing the existingReservations.

getId()

public abstract long getId()

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

optional uint64 id = 3355;

Returns
Type	Description
long	The id.

getKind()

public abstract String getKind()

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

optional string kind = 3292052;

Returns
Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
Type	Description
ByteString	The bytes for kind.

getLicenseResource()

public abstract LicenseResourceCommitment getLicenseResource()

The license specification required as part of a license commitment.

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

Returns
Type	Description
LicenseResourceCommitment	The licenseResource.

getLicenseResourceOrBuilder()

public abstract LicenseResourceCommitmentOrBuilder getLicenseResourceOrBuilder()

The license specification required as part of a license commitment.

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

Returns
Type	Description
LicenseResourceCommitmentOrBuilder

getMergeSourceCommitments(int index)

public abstract String getMergeSourceCommitments(int index)

List of source commitments to be merged into a new commitment.

repeated string merge_source_commitments = 188093761;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The mergeSourceCommitments at the given index.

getMergeSourceCommitmentsBytes(int index)

public abstract ByteString getMergeSourceCommitmentsBytes(int index)

List of source commitments to be merged into a new commitment.

repeated string merge_source_commitments = 188093761;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the mergeSourceCommitments at the given index.

getMergeSourceCommitmentsCount()

public abstract int getMergeSourceCommitmentsCount()

List of source commitments to be merged into a new commitment.

repeated string merge_source_commitments = 188093761;

Returns
Type	Description
int	The count of mergeSourceCommitments.

getMergeSourceCommitmentsList()

public abstract List<String> getMergeSourceCommitmentsList()

List of source commitments to be merged into a new commitment.

repeated string merge_source_commitments = 188093761;

Returns
Type	Description
List<String>	A list containing the mergeSourceCommitments.

getName()

public abstract 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
Type	Description
String	The name.

getNameBytes()

public abstract 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
Type	Description
ByteString	The bytes for name.

getPlan()

public abstract 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
Type	Description
String	The plan.

getPlanBytes()

public abstract 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
Type	Description
ByteString	The bytes for plan.

getRegion()

public abstract String getRegion()

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

optional string region = 138946292;

Returns
Type	Description
String	The region.

getRegionBytes()

public abstract ByteString getRegionBytes()

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

optional string region = 138946292;

Returns
Type	Description
ByteString	The bytes for region.

getReservations(int index)

public abstract Reservation getReservations(int index)

List of create-on-create reservations for this commitment.

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

Parameter
Name	Description
index	int

Returns
Type	Description
Reservation

getReservationsCount()

public abstract int getReservationsCount()

List of create-on-create reservations for this commitment.

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

Returns
Type	Description
int

getReservationsList()

public abstract List<Reservation> getReservationsList()

List of create-on-create reservations for this commitment.

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

Returns
Type	Description
List<Reservation>

getReservationsOrBuilder(int index)

public abstract ReservationOrBuilder getReservationsOrBuilder(int index)

List of create-on-create reservations for this commitment.

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

Parameter
Name	Description
index	int

Returns
Type	Description
ReservationOrBuilder

getReservationsOrBuilderList()

public abstract List<? extends ReservationOrBuilder> getReservationsOrBuilderList()

List of create-on-create reservations for this commitment.

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

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

getResources(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
ResourceCommitment

getResourcesCount()

public abstract 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
Type	Description
int

getResourcesList()

public abstract 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
Type	Description
List<ResourceCommitment>

getResourcesOrBuilder(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
ResourceCommitmentOrBuilder

getResourcesOrBuilderList()

public abstract 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
Type	Description
List<? extends com.google.cloud.compute.v1.ResourceCommitmentOrBuilder>

getSelfLink()

public abstract String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type	Description
String	The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type	Description
ByteString	The bytes for selfLink.

getSplitSourceCommitment()

public abstract String getSplitSourceCommitment()

Source commitment to be split into a new commitment.

optional string split_source_commitment = 402611156;

Returns
Type	Description
String	The splitSourceCommitment.

getSplitSourceCommitmentBytes()

public abstract ByteString getSplitSourceCommitmentBytes()

Source commitment to be split into a new commitment.

optional string split_source_commitment = 402611156;

Returns
Type	Description
ByteString	The bytes for splitSourceCommitment.

getStartTimestamp()

public abstract String getStartTimestamp()

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

optional string start_timestamp = 83645817;

Returns
Type	Description
String	The startTimestamp.

getStartTimestampBytes()

public abstract ByteString getStartTimestampBytes()

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

optional string start_timestamp = 83645817;

Returns
Type	Description
ByteString	The bytes for startTimestamp.

getStatus()

public abstract 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
Type	Description
String	The status.

getStatusBytes()

public abstract 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
Type	Description
ByteString	The bytes for status.

getStatusMessage()

public abstract String getStatusMessage()

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

optional string status_message = 297428154;

Returns
Type	Description
String	The statusMessage.

getStatusMessageBytes()

public abstract ByteString getStatusMessageBytes()

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

optional string status_message = 297428154;

Returns
Type	Description
ByteString	The bytes for statusMessage.

getType()

public abstract 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
Type	Description
String	The type.

getTypeBytes()

public abstract 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
Type	Description
ByteString	The bytes for type.

hasAutoRenew()

public abstract 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
Type	Description
boolean	Whether the autoRenew field is set.

hasCategory()

public abstract 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
Type	Description
boolean	Whether the category field is set.

hasCreationTimestamp()

public abstract boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
boolean	Whether the creationTimestamp field is set.

hasDescription()

public abstract boolean hasDescription()

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

optional string description = 422937596;

Returns
Type	Description
boolean	Whether the description field is set.

hasEndTimestamp()

public abstract boolean hasEndTimestamp()

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

optional string end_timestamp = 468096690;

Returns
Type	Description
boolean	Whether the endTimestamp field is set.

hasId()

public abstract boolean hasId()

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

optional uint64 id = 3355;

Returns
Type	Description
boolean	Whether the id field is set.

hasKind()

public abstract boolean hasKind()

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

optional string kind = 3292052;

Returns
Type	Description
boolean	Whether the kind field is set.

hasLicenseResource()

public abstract boolean hasLicenseResource()

The license specification required as part of a license commitment.

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

Returns
Type	Description
boolean	Whether the licenseResource field is set.

hasName()

public abstract 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
Type	Description
boolean	Whether the name field is set.

hasPlan()

public abstract 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
Type	Description
boolean	Whether the plan field is set.

hasRegion()

public abstract boolean hasRegion()

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

optional string region = 138946292;

Returns
Type	Description
boolean	Whether the region field is set.

hasSelfLink()

public abstract boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type	Description
boolean	Whether the selfLink field is set.

hasSplitSourceCommitment()

public abstract boolean hasSplitSourceCommitment()

Source commitment to be split into a new commitment.

optional string split_source_commitment = 402611156;

Returns
Type	Description
boolean	Whether the splitSourceCommitment field is set.

hasStartTimestamp()

public abstract boolean hasStartTimestamp()

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

optional string start_timestamp = 83645817;

Returns
Type	Description
boolean	Whether the startTimestamp field is set.

hasStatus()

public abstract 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
Type	Description
boolean	Whether the status field is set.

hasStatusMessage()

public abstract boolean hasStatusMessage()

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

optional string status_message = 297428154;

Returns
Type	Description
boolean	Whether the statusMessage field is set.

hasType()

public abstract 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
Type	Description
boolean	Whether the type field is set.