Class Commitment.Builder (1.13.0)

public static final class Commitment.Builder extends GeneratedMessageV3.Builder<Commitment.Builder> 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 Methods

getDescriptor()

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

Methods

addAllMergeSourceCommitments(Iterable<String> values)

public Commitment.Builder addAllMergeSourceCommitments(Iterable<String> values)

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

repeated string merge_source_commitments = 188093761;

Parameter
NameDescription
valuesIterable<String>

The mergeSourceCommitments to add.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

addAllReservations(Iterable<? extends Reservation> values)

public Commitment.Builder addAllReservations(Iterable<? extends Reservation> values)

List of reservations in this commitment.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.Reservation>
Returns
TypeDescription
Commitment.Builder

addAllResources(Iterable<? extends ResourceCommitment> values)

public Commitment.Builder addAllResources(Iterable<? extends ResourceCommitment> values)

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
valuesIterable<? extends com.google.cloud.compute.v1.ResourceCommitment>
Returns
TypeDescription
Commitment.Builder

addMergeSourceCommitments(String value)

public Commitment.Builder addMergeSourceCommitments(String value)

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

repeated string merge_source_commitments = 188093761;

Parameter
NameDescription
valueString

The mergeSourceCommitments to add.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

addMergeSourceCommitmentsBytes(ByteString value)

public Commitment.Builder addMergeSourceCommitmentsBytes(ByteString value)

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

repeated string merge_source_commitments = 188093761;

Parameter
NameDescription
valueByteString

The bytes of the mergeSourceCommitments to add.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Commitment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Commitment.Builder
Overrides

addReservations(Reservation value)

public Commitment.Builder addReservations(Reservation value)

List of reservations in this commitment.

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

Parameter
NameDescription
valueReservation
Returns
TypeDescription
Commitment.Builder

addReservations(Reservation.Builder builderForValue)

public Commitment.Builder addReservations(Reservation.Builder builderForValue)

List of reservations in this commitment.

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

Parameter
NameDescription
builderForValueReservation.Builder
Returns
TypeDescription
Commitment.Builder

addReservations(int index, Reservation value)

public Commitment.Builder addReservations(int index, Reservation value)

List of reservations in this commitment.

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

Parameters
NameDescription
indexint
valueReservation
Returns
TypeDescription
Commitment.Builder

addReservations(int index, Reservation.Builder builderForValue)

public Commitment.Builder addReservations(int index, Reservation.Builder builderForValue)

List of reservations in this commitment.

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

Parameters
NameDescription
indexint
builderForValueReservation.Builder
Returns
TypeDescription
Commitment.Builder

addReservationsBuilder()

public Reservation.Builder addReservationsBuilder()

List of reservations in this commitment.

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

Returns
TypeDescription
Reservation.Builder

addReservationsBuilder(int index)

public Reservation.Builder addReservationsBuilder(int index)

List of reservations in this commitment.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Reservation.Builder

addResources(ResourceCommitment value)

public Commitment.Builder addResources(ResourceCommitment value)

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
valueResourceCommitment
Returns
TypeDescription
Commitment.Builder

addResources(ResourceCommitment.Builder builderForValue)

public Commitment.Builder addResources(ResourceCommitment.Builder builderForValue)

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
builderForValueResourceCommitment.Builder
Returns
TypeDescription
Commitment.Builder

addResources(int index, ResourceCommitment value)

public Commitment.Builder addResources(int index, ResourceCommitment value)

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;

Parameters
NameDescription
indexint
valueResourceCommitment
Returns
TypeDescription
Commitment.Builder

addResources(int index, ResourceCommitment.Builder builderForValue)

public Commitment.Builder addResources(int index, ResourceCommitment.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueResourceCommitment.Builder
Returns
TypeDescription
Commitment.Builder

addResourcesBuilder()

public ResourceCommitment.Builder addResourcesBuilder()

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

addResourcesBuilder(int index)

public ResourceCommitment.Builder addResourcesBuilder(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.Builder

build()

public Commitment build()
Returns
TypeDescription
Commitment

buildPartial()

public Commitment buildPartial()
Returns
TypeDescription
Commitment

clear()

public Commitment.Builder clear()
Returns
TypeDescription
Commitment.Builder
Overrides

clearAutoRenew()

public Commitment.Builder clearAutoRenew()

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

This builder for chaining.

clearCategory()

public Commitment.Builder clearCategory()

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

This builder for chaining.

clearCreationTimestamp()

public Commitment.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

clearDescription()

public Commitment.Builder clearDescription()

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

optional string description = 422937596;

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

clearEndTimestamp()

public Commitment.Builder clearEndTimestamp()

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

optional string end_timestamp = 468096690;

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Commitment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Commitment.Builder
Overrides

clearId()

public Commitment.Builder clearId()

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

optional uint64 id = 3355;

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

clearKind()

public Commitment.Builder clearKind()

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

optional string kind = 3292052;

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

clearLicenseResource()

public Commitment.Builder clearLicenseResource()

The license specification required as part of a license commitment.

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

Returns
TypeDescription
Commitment.Builder

clearMergeSourceCommitments()

public Commitment.Builder clearMergeSourceCommitments()

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

repeated string merge_source_commitments = 188093761;

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

clearName()

public Commitment.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Commitment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Commitment.Builder
Overrides

clearPlan()

public Commitment.Builder clearPlan()

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

This builder for chaining.

clearRegion()

public Commitment.Builder clearRegion()

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

optional string region = 138946292;

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

clearReservations()

public Commitment.Builder clearReservations()

List of reservations in this commitment.

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

Returns
TypeDescription
Commitment.Builder

clearResources()

public Commitment.Builder clearResources()

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
Commitment.Builder
public Commitment.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

clearSplitSourceCommitment()

public Commitment.Builder clearSplitSourceCommitment()

Source commitment to be splitted into a new commitment.

optional string split_source_commitment = 402611156;

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

clearStartTimestamp()

public Commitment.Builder clearStartTimestamp()

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

optional string start_timestamp = 83645817;

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

clearStatus()

public Commitment.Builder clearStatus()

[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
Commitment.Builder

This builder for chaining.

clearStatusMessage()

public Commitment.Builder clearStatusMessage()

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

optional string status_message = 297428154;

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

clearType()

public Commitment.Builder clearType()

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

This builder for chaining.

clone()

public Commitment.Builder clone()
Returns
TypeDescription
Commitment.Builder
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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getLicenseResourceBuilder()

public LicenseResourceCommitment.Builder getLicenseResourceBuilder()

The license specification required as part of a license commitment.

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

Returns
TypeDescription
LicenseResourceCommitment.Builder

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

getMergeSourceCommitments(int index)

public String getMergeSourceCommitments(int index)

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

repeated string merge_source_commitments = 188093761;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The mergeSourceCommitments at the given index.

getMergeSourceCommitmentsBytes(int index)

public ByteString getMergeSourceCommitmentsBytes(int index)

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

repeated string merge_source_commitments = 188093761;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the mergeSourceCommitments at the given index.

getMergeSourceCommitmentsCount()

public int getMergeSourceCommitmentsCount()

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

repeated string merge_source_commitments = 188093761;

Returns
TypeDescription
int

The count of mergeSourceCommitments.

getMergeSourceCommitmentsList()

public ProtocolStringList getMergeSourceCommitmentsList()

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

repeated string merge_source_commitments = 188093761;

Returns
TypeDescription
ProtocolStringList

A list containing the mergeSourceCommitments.

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.

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

getReservationsBuilder(int index)

public Reservation.Builder getReservationsBuilder(int index)

List of reservations in this commitment.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Reservation.Builder

getReservationsBuilderList()

public List<Reservation.Builder> getReservationsBuilderList()

List of reservations in this commitment.

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

Returns
TypeDescription
List<Builder>

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

getResourcesBuilder(int index)

public ResourceCommitment.Builder getResourcesBuilder(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.Builder

getResourcesBuilderList()

public List<ResourceCommitment.Builder> getResourcesBuilderList()

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

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.

getSplitSourceCommitment()

public String getSplitSourceCommitment()

Source commitment to be splitted into a new commitment.

optional string split_source_commitment = 402611156;

Returns
TypeDescription
String

The splitSourceCommitment.

getSplitSourceCommitmentBytes()

public ByteString getSplitSourceCommitmentBytes()

Source commitment to be splitted into a new commitment.

optional string split_source_commitment = 402611156;

Returns
TypeDescription
ByteString

The bytes for splitSourceCommitment.

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.

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.

hasSplitSourceCommitment()

public boolean hasSplitSourceCommitment()

Source commitment to be splitted into a new commitment.

optional string split_source_commitment = 402611156;

Returns
TypeDescription
boolean

Whether the splitSourceCommitment 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Commitment other)

public Commitment.Builder mergeFrom(Commitment other)
Parameter
NameDescription
otherCommitment
Returns
TypeDescription
Commitment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Commitment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Commitment.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Commitment.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Commitment.Builder
Overrides

mergeLicenseResource(LicenseResourceCommitment value)

public Commitment.Builder mergeLicenseResource(LicenseResourceCommitment value)

The license specification required as part of a license commitment.

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

Parameter
NameDescription
valueLicenseResourceCommitment
Returns
TypeDescription
Commitment.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Commitment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Commitment.Builder
Overrides

removeReservations(int index)

public Commitment.Builder removeReservations(int index)

List of reservations in this commitment.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Commitment.Builder

removeResources(int index)

public Commitment.Builder removeResources(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
Commitment.Builder

setAutoRenew(boolean value)

public Commitment.Builder setAutoRenew(boolean value)

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;

Parameter
NameDescription
valueboolean

The autoRenew to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setCategory(String value)

public Commitment.Builder setCategory(String value)

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;

Parameter
NameDescription
valueString

The category to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setCategoryBytes(ByteString value)

public Commitment.Builder setCategoryBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for category to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setCreationTimestamp(String value)

public Commitment.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueString

The creationTimestamp to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public Commitment.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueByteString

The bytes for creationTimestamp to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setDescription(String value)

public Commitment.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Commitment.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setEndTimestamp(String value)

public Commitment.Builder setEndTimestamp(String value)

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

optional string end_timestamp = 468096690;

Parameter
NameDescription
valueString

The endTimestamp to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setEndTimestampBytes(ByteString value)

public Commitment.Builder setEndTimestampBytes(ByteString value)

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

optional string end_timestamp = 468096690;

Parameter
NameDescription
valueByteString

The bytes for endTimestamp to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Commitment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Commitment.Builder
Overrides

setId(long value)

public Commitment.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
NameDescription
valuelong

The id to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setKind(String value)

public Commitment.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
NameDescription
valueString

The kind to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setKindBytes(ByteString value)

public Commitment.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
NameDescription
valueByteString

The bytes for kind to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setLicenseResource(LicenseResourceCommitment value)

public Commitment.Builder setLicenseResource(LicenseResourceCommitment value)

The license specification required as part of a license commitment.

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

Parameter
NameDescription
valueLicenseResourceCommitment
Returns
TypeDescription
Commitment.Builder

setLicenseResource(LicenseResourceCommitment.Builder builderForValue)

public Commitment.Builder setLicenseResource(LicenseResourceCommitment.Builder builderForValue)

The license specification required as part of a license commitment.

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

Parameter
NameDescription
builderForValueLicenseResourceCommitment.Builder
Returns
TypeDescription
Commitment.Builder

setMergeSourceCommitments(int index, String value)

public Commitment.Builder setMergeSourceCommitments(int index, String value)

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

repeated string merge_source_commitments = 188093761;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The mergeSourceCommitments to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setName(String value)

public Commitment.Builder setName(String value)

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;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Commitment.Builder setNameBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setPlan(String value)

public Commitment.Builder setPlan(String value)

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;

Parameter
NameDescription
valueString

The plan to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setPlanBytes(ByteString value)

public Commitment.Builder setPlanBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for plan to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setRegion(String value)

public Commitment.Builder setRegion(String value)

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

optional string region = 138946292;

Parameter
NameDescription
valueString

The region to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public Commitment.Builder setRegionBytes(ByteString value)

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

optional string region = 138946292;

Parameter
NameDescription
valueByteString

The bytes for region to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Commitment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Commitment.Builder
Overrides

setReservations(int index, Reservation value)

public Commitment.Builder setReservations(int index, Reservation value)

List of reservations in this commitment.

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

Parameters
NameDescription
indexint
valueReservation
Returns
TypeDescription
Commitment.Builder

setReservations(int index, Reservation.Builder builderForValue)

public Commitment.Builder setReservations(int index, Reservation.Builder builderForValue)

List of reservations in this commitment.

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

Parameters
NameDescription
indexint
builderForValueReservation.Builder
Returns
TypeDescription
Commitment.Builder

setResources(int index, ResourceCommitment value)

public Commitment.Builder setResources(int index, ResourceCommitment value)

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;

Parameters
NameDescription
indexint
valueResourceCommitment
Returns
TypeDescription
Commitment.Builder

setResources(int index, ResourceCommitment.Builder builderForValue)

public Commitment.Builder setResources(int index, ResourceCommitment.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueResourceCommitment.Builder
Returns
TypeDescription
Commitment.Builder
public Commitment.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueString

The selfLink to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public Commitment.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueByteString

The bytes for selfLink to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setSplitSourceCommitment(String value)

public Commitment.Builder setSplitSourceCommitment(String value)

Source commitment to be splitted into a new commitment.

optional string split_source_commitment = 402611156;

Parameter
NameDescription
valueString

The splitSourceCommitment to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setSplitSourceCommitmentBytes(ByteString value)

public Commitment.Builder setSplitSourceCommitmentBytes(ByteString value)

Source commitment to be splitted into a new commitment.

optional string split_source_commitment = 402611156;

Parameter
NameDescription
valueByteString

The bytes for splitSourceCommitment to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setStartTimestamp(String value)

public Commitment.Builder setStartTimestamp(String value)

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

optional string start_timestamp = 83645817;

Parameter
NameDescription
valueString

The startTimestamp to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setStartTimestampBytes(ByteString value)

public Commitment.Builder setStartTimestampBytes(ByteString value)

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

optional string start_timestamp = 83645817;

Parameter
NameDescription
valueByteString

The bytes for startTimestamp to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setStatus(String value)

public Commitment.Builder setStatus(String value)

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

Parameter
NameDescription
valueString

The status to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setStatusBytes(ByteString value)

public Commitment.Builder setStatusBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for status to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setStatusMessage(String value)

public Commitment.Builder setStatusMessage(String value)

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

optional string status_message = 297428154;

Parameter
NameDescription
valueString

The statusMessage to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setStatusMessageBytes(ByteString value)

public Commitment.Builder setStatusMessageBytes(ByteString value)

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

optional string status_message = 297428154;

Parameter
NameDescription
valueByteString

The bytes for statusMessage to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setType(String value)

public Commitment.Builder setType(String value)

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;

Parameter
NameDescription
valueString

The type to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public Commitment.Builder setTypeBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for type to set.

Returns
TypeDescription
Commitment.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Commitment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Commitment.Builder
Overrides