- 1.69.0 (latest)
- 1.68.0
- 1.67.0
- 1.66.0
- 1.65.0
- 1.64.0
- 1.63.0
- 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 static final class Commitment.Builder extends GeneratedMessageV3.Builder<Commitment.Builder> implements CommitmentOrBuilder
Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts
Protobuf type google.cloud.compute.v1.Commitment
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Commitment.BuilderImplements
CommitmentOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllExistingReservations(Iterable<String> values)
public Commitment.Builder addAllExistingReservations(Iterable<String> values)
repeated string existing_reservations = 493028443;
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The existingReservations to add. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
addAllMergeSourceCommitments(Iterable<String> values)
public Commitment.Builder addAllMergeSourceCommitments(Iterable<String> values)
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The mergeSourceCommitments to add. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
addAllReservations(Iterable<? extends Reservation> values)
public Commitment.Builder addAllReservations(Iterable<? extends Reservation> values)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.compute.v1.Reservation> |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
addAllResources(Iterable<? extends ResourceCommitment> values)
public Commitment.Builder addAllResources(Iterable<? extends ResourceCommitment> values)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.compute.v1.ResourceCommitment> |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
addExistingReservations(String value)
public Commitment.Builder addExistingReservations(String value)
repeated string existing_reservations = 493028443;
Parameter | |
---|---|
Name | Description |
value |
String The existingReservations to add. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
addExistingReservationsBytes(ByteString value)
public Commitment.Builder addExistingReservationsBytes(ByteString value)
repeated string existing_reservations = 493028443;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the existingReservations to add. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
addMergeSourceCommitments(String value)
public Commitment.Builder addMergeSourceCommitments(String value)
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;
Parameter | |
---|---|
Name | Description |
value |
String The mergeSourceCommitments to add. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
addMergeSourceCommitmentsBytes(ByteString value)
public Commitment.Builder addMergeSourceCommitmentsBytes(ByteString value)
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the mergeSourceCommitments to add. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Commitment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
addReservations(Reservation value)
public Commitment.Builder addReservations(Reservation value)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameter | |
---|---|
Name | Description |
value |
Reservation |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
addReservations(Reservation.Builder builderForValue)
public Commitment.Builder addReservations(Reservation.Builder builderForValue)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameter | |
---|---|
Name | Description |
builderForValue |
Reservation.Builder |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
addReservations(int index, Reservation value)
public Commitment.Builder addReservations(int index, Reservation value)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
Reservation |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
addReservations(int index, Reservation.Builder builderForValue)
public Commitment.Builder addReservations(int index, Reservation.Builder builderForValue)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
Reservation.Builder |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
addReservationsBuilder()
public Reservation.Builder addReservationsBuilder()
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Returns | |
---|---|
Type | Description |
Reservation.Builder |
addReservationsBuilder(int index)
public Reservation.Builder addReservationsBuilder(int index)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Reservation.Builder |
addResources(ResourceCommitment value)
public Commitment.Builder addResources(ResourceCommitment value)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameter | |
---|---|
Name | Description |
value |
ResourceCommitment |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
addResources(ResourceCommitment.Builder builderForValue)
public Commitment.Builder addResources(ResourceCommitment.Builder builderForValue)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameter | |
---|---|
Name | Description |
builderForValue |
ResourceCommitment.Builder |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
addResources(int index, ResourceCommitment value)
public Commitment.Builder addResources(int index, ResourceCommitment value)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
ResourceCommitment |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
addResources(int index, ResourceCommitment.Builder builderForValue)
public Commitment.Builder addResources(int index, ResourceCommitment.Builder builderForValue)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
ResourceCommitment.Builder |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
addResourcesBuilder()
public ResourceCommitment.Builder addResourcesBuilder()
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Returns | |
---|---|
Type | Description |
ResourceCommitment.Builder |
addResourcesBuilder(int index)
public ResourceCommitment.Builder addResourcesBuilder(int index)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ResourceCommitment.Builder |
build()
public Commitment build()
Returns | |
---|---|
Type | Description |
Commitment |
buildPartial()
public Commitment buildPartial()
Returns | |
---|---|
Type | Description |
Commitment |
clear()
public Commitment.Builder clear()
Returns | |
---|---|
Type | Description |
Commitment.Builder |
clearAutoRenew()
public Commitment.Builder clearAutoRenew()
Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.
optional bool auto_renew = 495520765;
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
clearCategory()
public Commitment.Builder clearCategory()
The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. Check the Category enum for the list of possible values.
optional string category = 50511102;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
clearCustomEndTimestamp()
public Commitment.Builder clearCustomEndTimestamp()
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
optional string custom_end_timestamp = 181770852;
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
clearDescription()
public Commitment.Builder clearDescription()
An optional description of the commitment. You can provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
clearExistingReservations()
public Commitment.Builder clearExistingReservations()
repeated string existing_reservations = 493028443;
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Commitment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
Commitment.Builder |
clearMergeSourceCommitments()
public Commitment.Builder clearMergeSourceCommitments()
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
clearName()
public Commitment.Builder clearName()
Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
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 |
Commitment.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Commitment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
clearPlan()
public Commitment.Builder clearPlan()
The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Check the Plan enum for the list of possible values.
optional string plan = 3443497;
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
clearRegion()
public Commitment.Builder clearRegion()
[Output Only] URL of the region where the commitment and committed resources are located.
optional string region = 138946292;
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
clearReservations()
public Commitment.Builder clearReservations()
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Returns | |
---|---|
Type | Description |
Commitment.Builder |
clearResourceStatus()
public Commitment.Builder clearResourceStatus()
[Output Only] Status information for Commitment resource.
optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
Returns | |
---|---|
Type | Description |
Commitment.Builder |
clearResources()
public Commitment.Builder clearResources()
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Returns | |
---|---|
Type | Description |
Commitment.Builder |
clearSelfLink()
public Commitment.Builder clearSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
clearSplitSourceCommitment()
public Commitment.Builder clearSplitSourceCommitment()
The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
optional string split_source_commitment = 402611156;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. Check the Status enum for the list of possible values.
optional string status = 181260274;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
clearType()
public Commitment.Builder clearType()
The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. Check the Type enum for the list of possible values.
optional string type = 3575610;
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
clone()
public Commitment.Builder clone()
Returns | |
---|---|
Type | Description |
Commitment.Builder |
getAutoRenew()
public boolean getAutoRenew()
Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.
optional bool auto_renew = 495520765;
Returns | |
---|---|
Type | Description |
boolean |
The autoRenew. |
getCategory()
public String getCategory()
The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. Check the Category enum for the list of possible values.
optional string category = 50511102;
Returns | |
---|---|
Type | Description |
String |
The category. |
getCategoryBytes()
public ByteString getCategoryBytes()
The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. Check the Category enum for the list of possible values.
optional string category = 50511102;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for category. |
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
String |
The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for creationTimestamp. |
getCustomEndTimestamp()
public String getCustomEndTimestamp()
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
optional string custom_end_timestamp = 181770852;
Returns | |
---|---|
Type | Description |
String |
The customEndTimestamp. |
getCustomEndTimestampBytes()
public ByteString getCustomEndTimestampBytes()
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
optional string custom_end_timestamp = 181770852;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for customEndTimestamp. |
getDefaultInstanceForType()
public Commitment getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Commitment |
getDescription()
public String getDescription()
An optional description of the commitment. You can provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of the commitment. You can provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getEndTimestamp()
public String getEndTimestamp()
[Output Only] Commitment end time in RFC3339 text format.
optional string end_timestamp = 468096690;
Returns | |
---|---|
Type | Description |
String |
The endTimestamp. |
getEndTimestampBytes()
public 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 String getExistingReservations(int index)
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 ByteString getExistingReservationsBytes(int index)
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 int getExistingReservationsCount()
repeated string existing_reservations = 493028443;
Returns | |
---|---|
Type | Description |
int |
The count of existingReservations. |
getExistingReservationsList()
public ProtocolStringList getExistingReservationsList()
repeated string existing_reservations = 493028443;
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the existingReservations. |
getId()
public 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 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 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 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. |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
LicenseResourceCommitmentOrBuilder |
getMergeSourceCommitments(int index)
public String getMergeSourceCommitments(int index)
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;
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 ByteString getMergeSourceCommitmentsBytes(int index)
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;
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 int getMergeSourceCommitmentsCount()
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;
Returns | |
---|---|
Type | Description |
int |
The count of mergeSourceCommitments. |
getMergeSourceCommitmentsList()
public ProtocolStringList getMergeSourceCommitmentsList()
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the mergeSourceCommitments. |
getName()
public String getName()
Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
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 ByteString getNameBytes()
Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
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 String getPlan()
The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Check the Plan enum for the list of possible values.
optional string plan = 3443497;
Returns | |
---|---|
Type | Description |
String |
The plan. |
getPlanBytes()
public ByteString getPlanBytes()
The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Check the Plan enum for the list of possible values.
optional string plan = 3443497;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for plan. |
getRegion()
public String getRegion()
[Output Only] URL of the region where the commitment and committed resources are located.
optional string region = 138946292;
Returns | |
---|---|
Type | Description |
String |
The region. |
getRegionBytes()
public ByteString getRegionBytes()
[Output Only] URL of the region where the commitment and committed resources are located.
optional string region = 138946292;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for region. |
getReservations(int index)
public Reservation getReservations(int index)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Reservation |
getReservationsBuilder(int index)
public Reservation.Builder getReservationsBuilder(int index)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Reservation.Builder |
getReservationsBuilderList()
public List<Reservation.Builder> getReservationsBuilderList()
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Returns | |
---|---|
Type | Description |
List<Builder> |
getReservationsCount()
public int getReservationsCount()
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Returns | |
---|---|
Type | Description |
int |
getReservationsList()
public List<Reservation> getReservationsList()
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Returns | |
---|---|
Type | Description |
List<Reservation> |
getReservationsOrBuilder(int index)
public ReservationOrBuilder getReservationsOrBuilder(int index)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ReservationOrBuilder |
getReservationsOrBuilderList()
public List<? extends ReservationOrBuilder> getReservationsOrBuilderList()
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.compute.v1.ReservationOrBuilder> |
getResourceStatus()
public CommitmentResourceStatus getResourceStatus()
[Output Only] Status information for Commitment resource.
optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
Returns | |
---|---|
Type | Description |
CommitmentResourceStatus |
The resourceStatus. |
getResourceStatusBuilder()
public CommitmentResourceStatus.Builder getResourceStatusBuilder()
[Output Only] Status information for Commitment resource.
optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
Returns | |
---|---|
Type | Description |
CommitmentResourceStatus.Builder |
getResourceStatusOrBuilder()
public CommitmentResourceStatusOrBuilder getResourceStatusOrBuilder()
[Output Only] Status information for Commitment resource.
optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
Returns | |
---|---|
Type | Description |
CommitmentResourceStatusOrBuilder |
getResources(int index)
public ResourceCommitment getResources(int index)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ResourceCommitment |
getResourcesBuilder(int index)
public ResourceCommitment.Builder getResourcesBuilder(int index)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ResourceCommitment.Builder |
getResourcesBuilderList()
public List<ResourceCommitment.Builder> getResourcesBuilderList()
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Returns | |
---|---|
Type | Description |
List<Builder> |
getResourcesCount()
public int getResourcesCount()
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Returns | |
---|---|
Type | Description |
int |
getResourcesList()
public List<ResourceCommitment> getResourcesList()
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Returns | |
---|---|
Type | Description |
List<ResourceCommitment> |
getResourcesOrBuilder(int index)
public ResourceCommitmentOrBuilder getResourcesOrBuilder(int index)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ResourceCommitmentOrBuilder |
getResourcesOrBuilderList()
public List<? extends ResourceCommitmentOrBuilder> getResourcesOrBuilderList()
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Returns | |
---|---|
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;
Returns | |
---|---|
Type | Description |
String |
The selfLink. |
getSelfLinkBytes()
public 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 String getSplitSourceCommitment()
The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
optional string split_source_commitment = 402611156;
Returns | |
---|---|
Type | Description |
String |
The splitSourceCommitment. |
getSplitSourceCommitmentBytes()
public ByteString getSplitSourceCommitmentBytes()
The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
optional string split_source_commitment = 402611156;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for splitSourceCommitment. |
getStartTimestamp()
public String getStartTimestamp()
[Output Only] Commitment start time in RFC3339 text format.
optional string start_timestamp = 83645817;
Returns | |
---|---|
Type | Description |
String |
The startTimestamp. |
getStartTimestampBytes()
public 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 String getStatus()
[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. Check the Status enum for the list of possible values.
optional string status = 181260274;
Returns | |
---|---|
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). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. Check the Status enum for the list of possible values.
optional string status = 181260274;
Returns | |
---|---|
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;
Returns | |
---|---|
Type | Description |
String |
The statusMessage. |
getStatusMessageBytes()
public 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 String getType()
The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. Check the Type enum for the list of possible values.
optional string type = 3575610;
Returns | |
---|---|
Type | Description |
String |
The type. |
getTypeBytes()
public ByteString getTypeBytes()
The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. Check the Type enum for the list of possible values.
optional string type = 3575610;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for type. |
hasAutoRenew()
public boolean hasAutoRenew()
Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.
optional bool auto_renew = 495520765;
Returns | |
---|---|
Type | Description |
boolean |
Whether the autoRenew field is set. |
hasCategory()
public boolean hasCategory()
The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. Check the Category enum for the list of possible values.
optional string category = 50511102;
Returns | |
---|---|
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;
Returns | |
---|---|
Type | Description |
boolean |
Whether the creationTimestamp field is set. |
hasCustomEndTimestamp()
public boolean hasCustomEndTimestamp()
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
optional string custom_end_timestamp = 181770852;
Returns | |
---|---|
Type | Description |
boolean |
Whether the customEndTimestamp field is set. |
hasDescription()
public boolean hasDescription()
An optional description of the commitment. You can provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
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;
Returns | |
---|---|
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;
Returns | |
---|---|
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;
Returns | |
---|---|
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;
Returns | |
---|---|
Type | Description |
boolean |
Whether the licenseResource field is set. |
hasName()
public boolean hasName()
Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
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 boolean hasPlan()
The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Check the Plan enum for the list of possible values.
optional string plan = 3443497;
Returns | |
---|---|
Type | Description |
boolean |
Whether the plan field is set. |
hasRegion()
public boolean hasRegion()
[Output Only] URL of the region where the commitment and committed resources are located.
optional string region = 138946292;
Returns | |
---|---|
Type | Description |
boolean |
Whether the region field is set. |
hasResourceStatus()
public boolean hasResourceStatus()
[Output Only] Status information for Commitment resource.
optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
Returns | |
---|---|
Type | Description |
boolean |
Whether the resourceStatus field is set. |
hasSelfLink()
public 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 boolean hasSplitSourceCommitment()
The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
optional string split_source_commitment = 402611156;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
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). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. Check the Status enum for the list of possible values.
optional string status = 181260274;
Returns | |
---|---|
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;
Returns | |
---|---|
Type | Description |
boolean |
Whether the statusMessage field is set. |
hasType()
public boolean hasType()
The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. Check the Type enum for the list of possible values.
optional string type = 3575610;
Returns | |
---|---|
Type | Description |
boolean |
Whether the type field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(Commitment other)
public Commitment.Builder mergeFrom(Commitment other)
Parameter | |
---|---|
Name | Description |
other |
Commitment |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Commitment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Commitment.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
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 | |
---|---|
Name | Description |
value |
LicenseResourceCommitment |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
mergeResourceStatus(CommitmentResourceStatus value)
public Commitment.Builder mergeResourceStatus(CommitmentResourceStatus value)
[Output Only] Status information for Commitment resource.
optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
Parameter | |
---|---|
Name | Description |
value |
CommitmentResourceStatus |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Commitment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
removeReservations(int index)
public Commitment.Builder removeReservations(int index)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
removeResources(int index)
public Commitment.Builder removeResources(int index)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
setAutoRenew(boolean value)
public Commitment.Builder setAutoRenew(boolean value)
Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.
optional bool auto_renew = 495520765;
Parameter | |
---|---|
Name | Description |
value |
boolean The autoRenew to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setCategory(String value)
public Commitment.Builder setCategory(String value)
The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. Check the Category enum for the list of possible values.
optional string category = 50511102;
Parameter | |
---|---|
Name | Description |
value |
String The category to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setCategoryBytes(ByteString value)
public Commitment.Builder setCategoryBytes(ByteString value)
The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. Check the Category enum for the list of possible values.
optional string category = 50511102;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for category to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The creationTimestamp to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for creationTimestamp to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setCustomEndTimestamp(String value)
public Commitment.Builder setCustomEndTimestamp(String value)
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
optional string custom_end_timestamp = 181770852;
Parameter | |
---|---|
Name | Description |
value |
String The customEndTimestamp to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setCustomEndTimestampBytes(ByteString value)
public Commitment.Builder setCustomEndTimestampBytes(ByteString value)
[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
optional string custom_end_timestamp = 181770852;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for customEndTimestamp to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setDescription(String value)
public Commitment.Builder setDescription(String value)
An optional description of the commitment. You can provide this property when you create the resource.
optional string description = 422937596;
Parameter | |
---|---|
Name | Description |
value |
String The description to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public Commitment.Builder setDescriptionBytes(ByteString value)
An optional description of the commitment. You can provide this property when you create the resource.
optional string description = 422937596;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The endTimestamp to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for endTimestamp to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setExistingReservations(int index, String value)
public Commitment.Builder setExistingReservations(int index, String value)
repeated string existing_reservations = 493028443;
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The existingReservations to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Commitment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
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 | |
---|---|
Name | Description |
value |
long The id to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The kind to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for kind to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
LicenseResourceCommitment |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
builderForValue |
LicenseResourceCommitment.Builder |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
setMergeSourceCommitments(int index, String value)
public Commitment.Builder setMergeSourceCommitments(int index, String value)
The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
repeated string merge_source_commitments = 188093761;
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The mergeSourceCommitments to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setName(String value)
public Commitment.Builder setName(String value)
Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
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 | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Commitment.Builder setNameBytes(ByteString value)
Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setPlan(String value)
public Commitment.Builder setPlan(String value)
The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Check the Plan enum for the list of possible values.
optional string plan = 3443497;
Parameter | |
---|---|
Name | Description |
value |
String The plan to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setPlanBytes(ByteString value)
public Commitment.Builder setPlanBytes(ByteString value)
The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Check the Plan enum for the list of possible values.
optional string plan = 3443497;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for plan to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setRegion(String value)
public Commitment.Builder setRegion(String value)
[Output Only] URL of the region where the commitment and committed resources are located.
optional string region = 138946292;
Parameter | |
---|---|
Name | Description |
value |
String The region to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setRegionBytes(ByteString value)
public Commitment.Builder setRegionBytes(ByteString value)
[Output Only] URL of the region where the commitment and committed resources are located.
optional string region = 138946292;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for region to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
setReservations(int index, Reservation value)
public Commitment.Builder setReservations(int index, Reservation value)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
Reservation |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
setReservations(int index, Reservation.Builder builderForValue)
public Commitment.Builder setReservations(int index, Reservation.Builder builderForValue)
The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
Reservation.Builder |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
setResourceStatus(CommitmentResourceStatus value)
public Commitment.Builder setResourceStatus(CommitmentResourceStatus value)
[Output Only] Status information for Commitment resource.
optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
Parameter | |
---|---|
Name | Description |
value |
CommitmentResourceStatus |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
setResourceStatus(CommitmentResourceStatus.Builder builderForValue)
public Commitment.Builder setResourceStatus(CommitmentResourceStatus.Builder builderForValue)
[Output Only] Status information for Commitment resource.
optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
Parameter | |
---|---|
Name | Description |
builderForValue |
CommitmentResourceStatus.Builder |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
setResources(int index, ResourceCommitment value)
public Commitment.Builder setResources(int index, ResourceCommitment value)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
ResourceCommitment |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
setResources(int index, ResourceCommitment.Builder builderForValue)
public Commitment.Builder setResources(int index, ResourceCommitment.Builder builderForValue)
The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
ResourceCommitment.Builder |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
setSelfLink(String value)
public Commitment.Builder setSelfLink(String value)
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Parameter | |
---|---|
Name | Description |
value |
String The selfLink to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for selfLink to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setSplitSourceCommitment(String value)
public Commitment.Builder setSplitSourceCommitment(String value)
The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
optional string split_source_commitment = 402611156;
Parameter | |
---|---|
Name | Description |
value |
String The splitSourceCommitment to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setSplitSourceCommitmentBytes(ByteString value)
public Commitment.Builder setSplitSourceCommitmentBytes(ByteString value)
The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
optional string split_source_commitment = 402611156;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for splitSourceCommitment to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The startTimestamp to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for startTimestamp to set. |
Returns | |
---|---|
Type | Description |
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). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. Check the Status enum for the list of possible values.
optional string status = 181260274;
Parameter | |
---|---|
Name | Description |
value |
String The status to set. |
Returns | |
---|---|
Type | Description |
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). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. Check the Status enum for the list of possible values.
optional string status = 181260274;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for status to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The statusMessage to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for statusMessage to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setType(String value)
public Commitment.Builder setType(String value)
The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. Check the Type enum for the list of possible values.
optional string type = 3575610;
Parameter | |
---|---|
Name | Description |
value |
String The type to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setTypeBytes(ByteString value)
public Commitment.Builder setTypeBytes(ByteString value)
The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. Check the Type enum for the list of possible values.
optional string type = 3575610;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for type to set. |
Returns | |
---|---|
Type | Description |
Commitment.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Commitment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Commitment.Builder |