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



4157
4158
4159
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4157

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

Instance Attribute Details

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

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

Returns:



4071
4072
4073
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4071

def allocations
  @allocations
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


4076
4077
4078
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4076

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) 


4082
4083
4084
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4082

def description
  @description
end

#end_timestamp ⇒ String

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

Returns:

  • (String) 


4087
4088
4089
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4087

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) 


4093
4094
4095
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4093

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) 


4098
4099
4100
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4098

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) 


4108
4109
4110
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4108

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) 


4115
4116
4117
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4115

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) 


4120
4121
4122
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4120

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



4126
4127
4128
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4126

def resources
  @resources
end

#self_link ⇒ String

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

Returns:

  • (String) 


4131
4132
4133
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4131

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) 


4136
4137
4138
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4136

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) 


4143
4144
4145
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4143

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) 


4148
4149
4150
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4148

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) 


4155
4156
4157
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4155

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4162

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