Compute V1 Client - Class Commitment (1.25.0)

Reference documentation and code samples for the Compute V1 Client class Commitment.

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

Generated from protobuf message google.cloud.compute.v1.Commitment

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ auto_renew bool

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.
↳ category string

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.
↳ creation_timestamp string

[Output Only] Creation timestamp in RFC3339 text format.
↳ custom_end_timestamp string

[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.
↳ description string

An optional description of the commitment. You can provide this property when you create the resource.
↳ end_timestamp string

[Output Only] Commitment end time in RFC3339 text format.
↳ existing_reservations array
↳ id int|string

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

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

The license specification required as part of a license commitment.
↳ merge_source_commitments array

The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
↳ name string

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]([-a-z0-9]*[a-z0-9])? 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.
↳ plan string

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.
↳ region string

[Output Only] URL of the region where the commitment and committed resources are located.
↳ reservations array<Reservation>

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.
↳ resource_status CommitmentResourceStatus

[Output Only] Status information for Commitment resource.
↳ resources array<ResourceCommitment>

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.
↳ self_link string

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

The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
↳ start_timestamp string

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

[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.
↳ status_message string

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

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.

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.

Returns
Type Description
bool

hasAutoRenew

clearAutoRenew

setAutoRenew

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

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.

Returns
Type Description
string

hasCategory

clearCategory

setCategory

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

hasCustomEndTimestamp

clearCustomEndTimestamp

setCustomEndTimestamp

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

An optional description of the commitment. You can provide this property when you create the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

An optional description of the commitment. You can provide this property when you create the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getEndTimestamp

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

Returns
Type Description
string

hasEndTimestamp

clearEndTimestamp

setEndTimestamp

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

Parameter
Name Description
var string
Returns
Type Description
$this

getExistingReservations

Generated from protobuf field repeated string existing_reservations = 493028443;

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExistingReservations

Generated from protobuf field repeated string existing_reservations = 493028443;

Parameter
Name Description
var string[]
Returns
Type Description
$this

getId

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

Returns
Type Description
int|string

hasId

clearId

setId

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getKind

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

Returns
Type Description
string

hasKind

clearKind

setKind

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

Parameter
Name Description
var string
Returns
Type Description
$this

getLicenseResource

The license specification required as part of a license commitment.

Returns
Type Description
LicenseResourceCommitment|null

hasLicenseResource

clearLicenseResource

setLicenseResource

The license specification required as part of a license commitment.

Parameter
Name Description
var LicenseResourceCommitment
Returns
Type Description
$this

getMergeSourceCommitments

The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMergeSourceCommitments

The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.

Parameter
Name Description
var string[]
Returns
Type Description
$this

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]([-a-z0-9]*[a-z0-9])? 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.

Returns
Type Description
string

hasName

clearName

setName

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]([-a-z0-9]*[a-z0-9])? 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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

hasPlan

clearPlan

setPlan

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getRegion

[Output Only] URL of the region where the commitment and committed resources are located.

Returns
Type Description
string

hasRegion

clearRegion

setRegion

[Output Only] URL of the region where the commitment and committed resources are located.

Parameter
Name Description
var string
Returns
Type Description
$this

getReservations

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setReservations

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.

Parameter
Name Description
var array<Reservation>
Returns
Type Description
$this

getResourceStatus

[Output Only] Status information for Commitment resource.

Returns
Type Description
CommitmentResourceStatus|null

hasResourceStatus

clearResourceStatus

setResourceStatus

[Output Only] Status information for Commitment resource.

Parameter
Name Description
var CommitmentResourceStatus
Returns
Type Description
$this

getResources

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setResources

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.

Parameter
Name Description
var array<ResourceCommitment>
Returns
Type Description
$this

getSelfLink

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

Returns
Type Description
string

hasSelfLink

clearSelfLink

setSelfLink

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSplitSourceCommitment

The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.

Returns
Type Description
string

hasSplitSourceCommitment

clearSplitSourceCommitment

setSplitSourceCommitment

The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.

Parameter
Name Description
var string
Returns
Type Description
$this

getStartTimestamp

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

Returns
Type Description
string

hasStartTimestamp

clearStartTimestamp

setStartTimestamp

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

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

hasStatus

clearStatus

setStatus

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

Parameter
Name Description
var string
Returns
Type Description
$this

getStatusMessage

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

Returns
Type Description
string

hasStatusMessage

clearStatusMessage

setStatusMessage

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

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

hasType

clearType

setType

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.

Parameter
Name Description
var string
Returns
Type Description
$this