Class: Google::Apis::ComputeAlpha::Commitment
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Commitment
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/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
-
#auto_renew ⇒ Boolean
(also: #auto_renew?)
Specifies whether to enable automatic renewal for the commitment.
-
#category ⇒ String
The category of the commitment.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#end_timestamp ⇒ String
[Output Only] Commitment end time in RFC3339 text format.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#license_resource ⇒ Google::Apis::ComputeAlpha::LicenseResourceCommitment
Commitment for a particular license resource.
-
#merge_source_commitments ⇒ Array<String>
List of source commitments to be merged into a new commitment.
-
#name ⇒ String
Name of the resource.
-
#plan ⇒ String
The plan for this commitment, which determines duration and discount rate.
-
#region ⇒ String
[Output Only] URL of the region where this commitment may be used.
-
#reservations ⇒ Array<Google::Apis::ComputeAlpha::Reservation>
List of reservations in this commitment.
-
#resources ⇒ Array<Google::Apis::ComputeAlpha::ResourceCommitment>
A list of commitment amounts for particular resources.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#split_source_commitment ⇒ String
Source commitment to be splitted into a new commitment.
-
#start_timestamp ⇒ String
[Output Only] Commitment start time in RFC3339 text format.
-
#status ⇒ String
[Output Only] Status of the commitment with regards to eventual expiration ( each commitment has an end date defined).
-
#status_message ⇒ String
[Output Only] An optional, human-readable explanation of the status.
-
#type ⇒ String
The type of commitment, which affects the discount rate and the eligible resources.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Commitment
constructor
A new instance of Commitment.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Commitment
Returns a new instance of Commitment.
5539 5540 5541 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5539 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
5417 5418 5419 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5417 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
5427 5428 5429 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5427 def category @category end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
5432 5433 5434 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5432 def @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
5438 5439 5440 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5438 def description @description end |
#end_timestamp ⇒ String
[Output Only] Commitment end time in RFC3339 text format.
Corresponds to the JSON property endTimestamp
5443 5444 5445 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5443 def @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
5449 5450 5451 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5449 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#commitment for commitments.
Corresponds to the JSON property kind
5454 5455 5456 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5454 def kind @kind end |
#license_resource ⇒ Google::Apis::ComputeAlpha::LicenseResourceCommitment
Commitment for a particular license resource.
Corresponds to the JSON property licenseResource
5459 5460 5461 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5459 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
5464 5465 5466 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5464 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
5474 5475 5476 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5474 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
5481 5482 5483 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5481 def plan @plan end |
#region ⇒ String
[Output Only] URL of the region where this commitment may be used.
Corresponds to the JSON property region
5486 5487 5488 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5486 def region @region end |
#reservations ⇒ Array<Google::Apis::ComputeAlpha::Reservation>
List of reservations in this commitment.
Corresponds to the JSON property reservations
5491 5492 5493 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5491 def reservations @reservations 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
5497 5498 5499 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5497 def resources @resources end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
5502 5503 5504 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5502 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
Corresponds to the JSON property selfLinkWithId
5507 5508 5509 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5507 def self_link_with_id @self_link_with_id end |
#split_source_commitment ⇒ String
Source commitment to be splitted into a new commitment.
Corresponds to the JSON property splitSourceCommitment
5512 5513 5514 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5512 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
5517 5518 5519 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5517 def @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
5524 5525 5526 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5524 def status @status end |
#status_message ⇒ String
[Output Only] An optional, human-readable explanation of the status.
Corresponds to the JSON property statusMessage
5529 5530 5531 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5529 def @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
5537 5538 5539 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5537 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5544 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) @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) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @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 |