Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Commitment (v2.13.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#auto_renew

def auto_renew() -> ::Boolean
Returns
  • (::Boolean) — 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.

#auto_renew=

def auto_renew=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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

def category() -> ::String
Returns
  • (::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.

#category=

def category=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def creation_timestamp() -> ::String
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Creation timestamp in RFC3339 text format.
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#custom_end_timestamp

def custom_end_timestamp() -> ::String
Returns
  • (::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.

#custom_end_timestamp=

def custom_end_timestamp=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#end_timestamp

def end_timestamp() -> ::String
Returns
  • (::String) — [Output Only] Commitment end time in RFC3339 text format.

#end_timestamp=

def end_timestamp=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Commitment end time in RFC3339 text format.
Returns
  • (::String) — [Output Only] Commitment end time in RFC3339 text format.

#existing_reservations

def existing_reservations() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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

#existing_reservations=

def existing_reservations=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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
  • (::Array<::String>) — 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

def id() -> ::Integer
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#kind

def kind() -> ::String
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#commitment for commitments.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Type of the resource. Always compute#commitment for commitments.
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#commitment for commitments.

#license_resource

def license_resource() -> ::Google::Cloud::Compute::V1::LicenseResourceCommitment
Returns

#license_resource=

def license_resource=(value) -> ::Google::Cloud::Compute::V1::LicenseResourceCommitment
Parameter
Returns

#merge_source_commitments

def merge_source_commitments() -> ::Array<::String>
Returns
  • (::Array<::String>) — List of source commitments to be merged into a new commitment.

#merge_source_commitments=

def merge_source_commitments=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — List of source commitments to be merged into a new commitment.
Returns
  • (::Array<::String>) — List of source commitments to be merged into a new commitment.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def plan() -> ::String
Returns
  • (::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.

#plan=

def plan=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def region() -> ::String
Returns
  • (::String) — [Output Only] URL of the region where this commitment may be used.

#region=

def region=(value) -> ::String
Parameter
  • value (::String) — [Output Only] URL of the region where this commitment may be used.
Returns
  • (::String) — [Output Only] URL of the region where this commitment may be used.

#reservations

def reservations() -> ::Array<::Google::Cloud::Compute::V1::Reservation>
Returns

#reservations=

def reservations=(value) -> ::Array<::Google::Cloud::Compute::V1::Reservation>
Parameter
Returns

#resource_status

def resource_status() -> ::Google::Cloud::Compute::V1::CommitmentResourceStatus
Returns

#resource_status=

def resource_status=(value) -> ::Google::Cloud::Compute::V1::CommitmentResourceStatus
Parameter
Returns

#resources

def resources() -> ::Array<::Google::Cloud::Compute::V1::ResourceCommitment>
Returns

#resources=

def resources=(value) -> ::Array<::Google::Cloud::Compute::V1::ResourceCommitment>
Parameter
Returns

#self_link

def self_link() -> ::String
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Server-defined URL for the resource.
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#split_source_commitment

def split_source_commitment() -> ::String
Returns
  • (::String) — Source commitment to be split into a new commitment.

#split_source_commitment=

def split_source_commitment=(value) -> ::String
Parameter
  • value (::String) — Source commitment to be split into a new commitment.
Returns
  • (::String) — Source commitment to be split into a new commitment.

#start_timestamp

def start_timestamp() -> ::String
Returns
  • (::String) — [Output Only] Commitment start time in RFC3339 text format.

#start_timestamp=

def start_timestamp=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Commitment start time in RFC3339 text format.
Returns
  • (::String) — [Output Only] Commitment start time in RFC3339 text format.

#status

def status() -> ::String
Returns
  • (::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=

def status=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def status_message() -> ::String
Returns
  • (::String) — [Output Only] An optional, human-readable explanation of the status.

#status_message=

def status_message=(value) -> ::String
Parameter
  • value (::String) — [Output Only] An optional, human-readable explanation of the status.
Returns
  • (::String) — [Output Only] An optional, human-readable explanation of the status.

#type

def type() -> ::String
Returns
  • (::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.

#type=

def type=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.