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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/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. (== resource_for beta. regionCommitments ==) (== resource_for v1.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



4357
4358
4359
# File 'generated/google/apis/compute_alpha/classes.rb', line 4357

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)


4266
4267
4268
# File 'generated/google/apis/compute_alpha/classes.rb', line 4266

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)


4272
4273
4274
# File 'generated/google/apis/compute_alpha/classes.rb', line 4272

def description
  @description
end

#end_timestampString

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

Returns:

  • (String)


4277
4278
4279
# File 'generated/google/apis/compute_alpha/classes.rb', line 4277

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)


4283
4284
4285
# File 'generated/google/apis/compute_alpha/classes.rb', line 4283

def id
  @id
end

#kindString

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

Returns:

  • (String)


4288
4289
4290
# File 'generated/google/apis/compute_alpha/classes.rb', line 4288

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)


4298
4299
4300
# File 'generated/google/apis/compute_alpha/classes.rb', line 4298

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)


4305
4306
4307
# File 'generated/google/apis/compute_alpha/classes.rb', line 4305

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)


4310
4311
4312
# File 'generated/google/apis/compute_alpha/classes.rb', line 4310

def region
  @region
end

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

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



4315
4316
4317
# File 'generated/google/apis/compute_alpha/classes.rb', line 4315

def reservations
  @reservations
end

#resourcesArray<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



4321
4322
4323
# File 'generated/google/apis/compute_alpha/classes.rb', line 4321

def resources
  @resources
end

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

Returns:

  • (String)


4326
4327
4328
# File 'generated/google/apis/compute_alpha/classes.rb', line 4326

def self_link
  @self_link
end

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

Returns:

  • (String)


4331
4332
4333
# File 'generated/google/apis/compute_alpha/classes.rb', line 4331

def self_link_with_id
  @self_link_with_id
end

#start_timestampString

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

Returns:

  • (String)


4336
4337
4338
# File 'generated/google/apis/compute_alpha/classes.rb', line 4336

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)


4343
4344
4345
# File 'generated/google/apis/compute_alpha/classes.rb', line 4343

def status
  @status
end

#status_messageString

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

Returns:

  • (String)


4348
4349
4350
# File 'generated/google/apis/compute_alpha/classes.rb', line 4348

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)


4355
4356
4357
# File 'generated/google/apis/compute_alpha/classes.rb', line 4355

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'generated/google/apis/compute_alpha/classes.rb', line 4362

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