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

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



3147
3148
3149
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3147

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) 


3073
3074
3075
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3073

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) 


3079
3080
3081
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3079

def description
  @description
end

#end_timestamp ⇒ String

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

Returns:

  • (String) 


3084
3085
3086
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3084

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) 


3090
3091
3092
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3090

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) 


3095
3096
3097
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3095

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) 


3105
3106
3107
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3105

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) 


3112
3113
3114
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3112

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) 


3117
3118
3119
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3117

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



3123
3124
3125
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3123

def resources
  @resources
end

#self_link ⇒ String

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

Returns:

  • (String) 


3128
3129
3130
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3128

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) 


3133
3134
3135
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3133

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) 


3140
3141
3142
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3140

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) 


3145
3146
3147
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3145

def status_message
  @status_message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3152

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