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.
5680 5681 5682 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5680 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
5558 5559 5560 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5558 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
5568 5569 5570 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5568 def category @category end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
5573 5574 5575 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5573 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
5579 5580 5581 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5579 def description @description end |
#end_timestamp ⇒ String
[Output Only] Commitment end time in RFC3339 text format.
Corresponds to the JSON property endTimestamp
5584 5585 5586 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5584 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
5590 5591 5592 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5590 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#commitment for commitments.
Corresponds to the JSON property kind
5595 5596 5597 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5595 def kind @kind end |
#license_resource ⇒ Google::Apis::ComputeAlpha::LicenseResourceCommitment
Commitment for a particular license resource.
Corresponds to the JSON property licenseResource
5600 5601 5602 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5600 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
5605 5606 5607 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5605 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
5615 5616 5617 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5615 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
5622 5623 5624 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5622 def plan @plan end |
#region ⇒ String
[Output Only] URL of the region where this commitment may be used.
Corresponds to the JSON property region
5627 5628 5629 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5627 def region @region end |
#reservations ⇒ Array<Google::Apis::ComputeAlpha::Reservation>
List of reservations in this commitment.
Corresponds to the JSON property reservations
5632 5633 5634 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5632 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
5638 5639 5640 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5638 def resources @resources end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
5643 5644 5645 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5643 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
5648 5649 5650 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5648 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
5653 5654 5655 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5653 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
5658 5659 5660 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5658 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
5665 5666 5667 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5665 def status @status end |
#status_message ⇒ String
[Output Only] An optional, human-readable explanation of the status.
Corresponds to the JSON property statusMessage
5670 5671 5672 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5670 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
5678 5679 5680 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5678 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5685 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 |