Class: Google::Apis::ComputeV1::Commitment

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



5549
5550
5551
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5549

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) 


5423
5424
5425
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5423

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) 


5433
5434
5435
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5433

def category
  @category
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


5438
5439
5440
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5438

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) 


5444
5445
5446
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5444

def description
  @description
end

#end_timestamp ⇒ String

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

Returns:

  • (String) 


5449
5450
5451
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5449

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


5458
5459
5460
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5458

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) 


5464
5465
5466
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5464

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) 


5469
5470
5471
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5469

def kind
  @kind
end

#license_resource ⇒ Google::Apis::ComputeV1::LicenseResourceCommitment

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

Returns:



5474
5475
5476
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5474

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


5479
5480
5481
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5479

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) 


5489
5490
5491
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5489

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) 


5496
5497
5498
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5496

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) 


5501
5502
5503
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5501

def region
  @region
end

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

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

Returns:



5506
5507
5508
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5506

def reservations
  @reservations
end

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



5512
5513
5514
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5512

def resources
  @resources
end

#self_link ⇒ String

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

Returns:

  • (String) 


5517
5518
5519
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5517

def self_link
  @self_link
end

#split_source_commitment ⇒ String

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

Returns:

  • (String) 


5522
5523
5524
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5522

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) 


5527
5528
5529
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5527

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) 


5534
5535
5536
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5534

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) 


5539
5540
5541
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5539

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) 


5547
5548
5549
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5547

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5554

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)
  @resources = args[:resources] if args.key?(:resources)
  @self_link = args[:self_link] if args.key?(:self_link)
  @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