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

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#auto_renew

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

#auto_renew=

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

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

#category=

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

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

#custom_end_timestamp=

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

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

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of the commitment. You can provide this property when you create the resource.
Returns
  • (::String) — An optional description of the commitment. You can 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>)

#existing_reservations=

def existing_reservations=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>)
Returns
  • (::Array<::String>)

#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>) — The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.

#merge_source_commitments=

def merge_source_commitments=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
Returns
  • (::Array<::String>) — The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.

#name

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

#name=

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

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

#plan=

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

def region() -> ::String
Returns
  • (::String) — [Output Only] URL of the region where the commitment and committed resources are located.

#region=

def region=(value) -> ::String
Parameter
  • value (::String) — [Output Only] URL of the region where the commitment and committed resources are located.
Returns
  • (::String) — [Output Only] URL of the region where the commitment and committed resources are located.

#reservations

def reservations() -> ::Array<::Google::Cloud::Compute::V1::Reservation>
Returns
  • (::Array<::Google::Cloud::Compute::V1::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.

#reservations=

def reservations=(value) -> ::Array<::Google::Cloud::Compute::V1::Reservation>
Parameter
  • value (::Array<::Google::Cloud::Compute::V1::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.
Returns
  • (::Array<::Google::Cloud::Compute::V1::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

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
  • value (::Array<::Google::Cloud::Compute::V1::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.
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) — The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.

#split_source_commitment=

def split_source_commitment=(value) -> ::String
Parameter
  • value (::String) — The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
Returns
  • (::String) — The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.

#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). 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=

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). 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
  • (::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

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

#type=

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