Class: Google::Apis::ComputeAlpha::Commitment

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Commitment

Returns a new instance of Commitment.



5251
5252
5253
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5251

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

Instance Attribute Details

#auto_renew ⇒ Boolean Also known as: auto_renew?

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

Returns:

  • (Boolean) 


5139
5140
5141
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5139

def auto_renew
  @auto_renew
end

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

Returns:

  • (String) 


5149
5150
5151
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5149

def category
  @category
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


5154
5155
5156
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5154

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

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

Returns:

  • (String) 


5160
5161
5162
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5160

def description
  @description
end

#end_timestamp ⇒ String

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

Returns:

  • (String) 


5165
5166
5167
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5165

def end_timestamp
  @end_timestamp
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5171
5172
5173
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5171

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


5176
5177
5178
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5176

def kind
  @kind
end

#license_resource ⇒ Google::Apis::ComputeAlpha::LicenseResourceCommitment

Commitment for a particular license resource. Corresponds to the JSON property licenseResource

Returns:



5181
5182
5183
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5181

def license_resource
  @license_resource
end

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

Returns:

  • (String) 


5191
5192
5193
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5191

def name
  @name
end

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

Returns:

  • (String) 


5198
5199
5200
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5198

def plan
  @plan
end

#region ⇒ String

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

Returns:

  • (String) 


5203
5204
5205
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5203

def region
  @region
end

#reservations ⇒ Array<Google::Apis::ComputeAlpha::Reservation>

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

Returns:



5208
5209
5210
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5208

def reservations
  @reservations
end

#resources ⇒ Array<Google::Apis::ComputeAlpha::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

Returns:



5214
5215
5216
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5214

def resources
  @resources
end

#self_link ⇒ String

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

Returns:

  • (String) 


5219
5220
5221
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5219

def self_link
  @self_link
end

#self_link_with_id ⇒ String

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


5224
5225
5226
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5224

def self_link_with_id
  @self_link_with_id
end

#start_timestamp ⇒ String

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

Returns:

  • (String) 


5229
5230
5231
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5229

def start_timestamp
  @start_timestamp
end

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

Returns:

  • (String) 


5236
5237
5238
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5236

def status
  @status
end

#status_message ⇒ String

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

Returns:

  • (String) 


5241
5242
5243
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5241

def status_message
  @status_message
end

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

Returns:

  • (String) 


5249
5250
5251
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5249

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 5256

def update!(**args)
  @auto_renew = args[:auto_renew] if args.key?(:auto_renew)
  @category = args[:category] if args.key?(:category)
  @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)
  @license_resource = args[:license_resource] if args.key?(:license_resource)
  @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)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @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