Compute V1 Client - Class Commitment (1.20.0)

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

Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.

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 enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
↳ category string

The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. Check the Category enum for the list of possible values.
↳ creation_timestamp string

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

[Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
↳ description string

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

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

Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
↳ 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 Google\Cloud\Compute\V1\LicenseResourceCommitment

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

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

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-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 plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Check the Plan enum for the list of possible values.
↳ region string

[Output Only] URL of the region where this commitment may be used.
↳ reservations array<Google\Cloud\Compute\V1\Reservation>

List of create-on-create reservations for this commitment.
↳ resource_status Google\Cloud\Compute\V1\CommitmentResourceStatus

[Output Only] Status information for Commitment resource.
↳ resources array<Google\Cloud\Compute\V1\ResourceCommitment>

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
↳ self_link string

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

Source commitment to be split into a new commitment.
↳ 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). One of the following values: NOT_YET_ACTIVE, ACTIVE, 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, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. Check the Type enum for the list of possible values.

getAutoRenew

Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.

Returns
Type Description
bool

hasAutoRenew

clearAutoRenew

setAutoRenew

Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.

Parameter
Name Description
var bool
Returns
Type Description
$this

getCategory

The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.

Check the Category enum for the list of possible values.

Returns
Type Description
string

hasCategory

clearCategory

setCategory

The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.

Check the Category enum for the list of possible values.

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 CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.

Returns
Type Description
string

hasCustomEndTimestamp

clearCustomEndTimestamp

setCustomEndTimestamp

[Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD'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 this resource. Provide this property when you create the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

An optional description of this resource. 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

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExistingReservations

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

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
Google\Cloud\Compute\V1\LicenseResourceCommitment|null

hasLicenseResource

clearLicenseResource

setLicenseResource

The license specification required as part of a license commitment.

Parameter
Name Description
var Google\Cloud\Compute\V1\LicenseResourceCommitment
Returns
Type Description
$this

getMergeSourceCommitments

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMergeSourceCommitments

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

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

getName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-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 resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-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 plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).

Check the Plan enum for the list of possible values.

Returns
Type Description
string

hasPlan

clearPlan

setPlan

The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).

Check the Plan enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getRegion

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

Returns
Type Description
string

hasRegion

clearRegion

setRegion

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

Parameter
Name Description
var string
Returns
Type Description
$this

getReservations

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setReservations

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

Parameter
Name Description
var array<Google\Cloud\Compute\V1\Reservation>
Returns
Type Description
$this

getResourceStatus

[Output Only] Status information for Commitment resource.

Returns
Type Description
Google\Cloud\Compute\V1\CommitmentResourceStatus|null

hasResourceStatus

clearResourceStatus

setResourceStatus

[Output Only] Status information for Commitment resource.

Parameter
Name Description
var Google\Cloud\Compute\V1\CommitmentResourceStatus
Returns
Type Description
$this

getResources

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setResources

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

Parameter
Name Description
var array<Google\Cloud\Compute\V1\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

Source commitment to be split into a new commitment.

Returns
Type Description
string

hasSplitSourceCommitment

clearSplitSourceCommitment

setSplitSourceCommitment

Source commitment to be split into a new commitment.

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). One of the following values: NOT_YET_ACTIVE, ACTIVE, 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). One of the following values: NOT_YET_ACTIVE, ACTIVE, 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, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.

Check the Type enum for the list of possible values.

Returns
Type Description
string

hasType

clearType

setType

The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.

Check the Type enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this