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.



6245
6246
6247
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6245

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) 


6109
6110
6111
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6109

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) 


6119
6120
6121
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6119

def category
  @category
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


6124
6125
6126
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6124

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) 


6130
6131
6132
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6130

def description
  @description
end

#end_timestamp ⇒ String

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

Returns:

  • (String) 


6135
6136
6137
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6135

def end_timestamp
  @end_timestamp
end

#existing_reservations ⇒ 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 Corresponds to the JSON property existingReservations

Returns:

  • (Array<String>) 


6144
6145
6146
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6144

def existing_reservations
  @existing_reservations
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) 


6150
6151
6152
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6150

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) 


6155
6156
6157
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6155

def kind
  @kind
end

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

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

Returns:



6160
6161
6162
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6160

def license_resource
  @license_resource
end

#merge_source_commitments ⇒ Array<String>

List of source commitments to be merged into a new commitment. Corresponds to the JSON property mergeSourceCommitments

Returns:

  • (Array<String>) 


6165
6166
6167
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6165

def merge_source_commitments
  @merge_source_commitments
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) 


6175
6176
6177
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6175

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) 


6182
6183
6184
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6182

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) 


6187
6188
6189
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6187

def region
  @region
end

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

List of create-on-create reservations for this commitment. Corresponds to the JSON property reservations

Returns:



6192
6193
6194
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6192

def reservations
  @reservations
end

#resource_status ⇒ Google::Apis::ComputeAlpha::CommitmentResourceStatus

[Output Only] Contains output only fields. Corresponds to the JSON property resourceStatus

Returns:



6197
6198
6199
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6197

def resource_status
  @resource_status
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:



6203
6204
6205
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6203

def resources
  @resources
end

#self_link ⇒ String

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

Returns:

  • (String) 


6208
6209
6210
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6208

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) 


6213
6214
6215
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6213

def self_link_with_id
  @self_link_with_id
end

#split_source_commitment ⇒ String

Source commitment to be split into a new commitment. Corresponds to the JSON property splitSourceCommitment

Returns:

  • (String) 


6218
6219
6220
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6218

def split_source_commitment
  @split_source_commitment
end

#start_timestamp ⇒ String

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

Returns:

  • (String) 


6223
6224
6225
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6223

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) 


6230
6231
6232
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6230

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) 


6235
6236
6237
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6235

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) 


6243
6244
6245
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6243

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 6250

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)
  @existing_reservations = args[:existing_reservations] if args.key?(:existing_reservations)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @license_resource = args[:license_resource] if args.key?(:license_resource)
  @merge_source_commitments = args[:merge_source_commitments] if args.key?(:merge_source_commitments)
  @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)
  @resource_status = args[:resource_status] if args.key?(:resource_status)
  @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)
  @split_source_commitment = args[:split_source_commitment] if args.key?(:split_source_commitment)
  @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