Class: Google::Apis::ComputeBeta::Commitment

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_beta/classes.rb,
generated/google/apis/compute_beta/representations.rb,
generated/google/apis/compute_beta/representations.rb

Overview

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. (== resource_for $api_version. regionCommitments ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Commitment

Returns a new instance of Commitment.



4101
4102
4103
# File 'generated/google/apis/compute_beta/classes.rb', line 4101

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#creation_timestampString

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String)


4015
4016
4017
# File 'generated/google/apis/compute_beta/classes.rb', line 4015

def creation_timestamp
  @creation_timestamp
end

#descriptionString

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String)


4021
4022
4023
# File 'generated/google/apis/compute_beta/classes.rb', line 4021

def description
  @description
end

#end_timestampString

[Output Only] Commitment end time in RFC3339 text format. Corresponds to the JSON property endTimestamp

Returns:

  • (String)


4026
4027
4028
# File 'generated/google/apis/compute_beta/classes.rb', line 4026

def end_timestamp
  @end_timestamp
end

#idFixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum)


4032
4033
4034
# File 'generated/google/apis/compute_beta/classes.rb', line 4032

def id
  @id
end

#kindString

[Output Only] Type of the resource. Always compute#commitment for commitments. Corresponds to the JSON property kind

Returns:

  • (String)


4037
4038
4039
# File 'generated/google/apis/compute_beta/classes.rb', line 4037

def kind
  @kind
end

#nameString

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. Corresponds to the JSON property name

Returns:

  • (String)


4047
4048
4049
# File 'generated/google/apis/compute_beta/classes.rb', line 4047

def name
  @name
end

#planString

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). Corresponds to the JSON property plan

Returns:

  • (String)


4054
4055
4056
# File 'generated/google/apis/compute_beta/classes.rb', line 4054

def plan
  @plan
end

#regionString

[Output Only] URL of the region where this commitment may be used. Corresponds to the JSON property region

Returns:

  • (String)


4059
4060
4061
# File 'generated/google/apis/compute_beta/classes.rb', line 4059

def region
  @region
end

#reservationsArray<Google::Apis::ComputeBeta::Reservation>

List of reservations in this commitment. Corresponds to the JSON property reservations



4064
4065
4066
# File 'generated/google/apis/compute_beta/classes.rb', line 4064

def reservations
  @reservations
end

#resourcesArray<Google::Apis::ComputeBeta::ResourceCommitment>

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. Corresponds to the JSON property resources



4070
4071
4072
# File 'generated/google/apis/compute_beta/classes.rb', line 4070

def resources
  @resources
end

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String)


4075
4076
4077
# File 'generated/google/apis/compute_beta/classes.rb', line 4075

def self_link
  @self_link
end

#start_timestampString

[Output Only] Commitment start time in RFC3339 text format. Corresponds to the JSON property startTimestamp

Returns:

  • (String)


4080
4081
4082
# File 'generated/google/apis/compute_beta/classes.rb', line 4080

def start_timestamp
  @start_timestamp
end

#statusString

[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. Corresponds to the JSON property status

Returns:

  • (String)


4087
4088
4089
# File 'generated/google/apis/compute_beta/classes.rb', line 4087

def status
  @status
end

#status_messageString

[Output Only] An optional, human-readable explanation of the status. Corresponds to the JSON property statusMessage

Returns:

  • (String)


4092
4093
4094
# File 'generated/google/apis/compute_beta/classes.rb', line 4092

def status_message
  @status_message
end

#typeString

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. Corresponds to the JSON property type

Returns:

  • (String)


4099
4100
4101
# File 'generated/google/apis/compute_beta/classes.rb', line 4099

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
# File 'generated/google/apis/compute_beta/classes.rb', line 4106

def update!(**args)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @end_timestamp = args[:end_timestamp] if args.key?(:end_timestamp)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @plan = args[:plan] if args.key?(:plan)
  @region = args[:region] if args.key?(:region)
  @reservations = args[:reservations] if args.key?(:reservations)
  @resources = args[:resources] if args.key?(:resources)
  @self_link = args[:self_link] if args.key?(:self_link)
  @start_timestamp = args[:start_timestamp] if args.key?(:start_timestamp)
  @status = args[:status] if args.key?(:status)
  @status_message = args[:status_message] if args.key?(:status_message)
  @type = args[:type] if args.key?(:type)
end