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

Overview

Represents a 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. Committed use discounts are subject to Google Cloud Platform's Service Specific Terms. By purchasing a committed use discount, you agree to these terms. Committed use discounts will not renew, so you must purchase a new commitment to continue receiving discounts. (== resource_for beta.commitments = =) (== resource_for v1.commitments ==)

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

[View source]

3754
3755
3756
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3754

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

Instance Attribute Details

#allocations ⇒ Array<Google::Apis::ComputeBeta::Allocation>

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

Returns:


3675
3676
3677
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3675

def allocations
  @allocations
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 

3680
3681
3682
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3680

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) 

3686
3687
3688
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3686

def description
  @description
end

#end_timestamp ⇒ String

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

Returns:

  • (String) 

3691
3692
3693
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3691

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) 

3697
3698
3699
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3697

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) 

3702
3703
3704
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3702

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) 

3712
3713
3714
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3712

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) 

3719
3720
3721
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3719

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) 

3724
3725
3726
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3724

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


3730
3731
3732
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3730

def resources
  @resources
end

#self_link ⇒ String

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

Returns:

  • (String) 

3735
3736
3737
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3735

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) 

3740
3741
3742
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3740

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) 

3747
3748
3749
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3747

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) 

3752
3753
3754
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3752

def status_message
  @status_message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
 
# File 'generated/google/apis/compute_beta/classes.rb', line 3759

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