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



3926
3927
3928
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3926

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

Instance Attribute Details

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


3840
3841
3842
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3840

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) 


3846
3847
3848
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3846

def description
  @description
end

#end_timestamp ⇒ String

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

Returns:

  • (String) 


3851
3852
3853
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3851

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) 


3857
3858
3859
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3857

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) 


3862
3863
3864
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3862

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


3872
3873
3874
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3872

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) 


3879
3880
3881
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3879

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) 


3884
3885
3886
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3884

def region
  @region
end

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

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

Returns:



3889
3890
3891
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3889

def reservations
  @reservations
end

#resources ⇒ Array<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

Returns:



3895
3896
3897
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3895

def resources
  @resources
end

#self_link ⇒ String

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

Returns:

  • (String) 


3900
3901
3902
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3900

def self_link
  @self_link
end

#start_timestamp ⇒ String

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

Returns:

  • (String) 


3905
3906
3907
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3905

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) 


3912
3913
3914
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3912

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) 


3917
3918
3919
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3917

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

Returns:

  • (String) 


3924
3925
3926
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3924

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3931

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