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.
5662 5663 5664 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5662 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
5540 5541 5542 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5540 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
5550 5551 5552 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5550 def category @category end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
5555 5556 5557 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5555 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
5561 5562 5563 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5561 def description @description end |
#end_timestamp ⇒ String
[Output Only] Commitment end time in RFC3339 text format.
Corresponds to the JSON property endTimestamp
5566 5567 5568 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5566 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
5572 5573 5574 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5572 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#commitment for commitments.
Corresponds to the JSON property kind
5577 5578 5579 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5577 def kind @kind end |
#license_resource ⇒ Google::Apis::ComputeAlpha::LicenseResourceCommitment
Commitment for a particular license resource.
Corresponds to the JSON property licenseResource
5582 5583 5584 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5582 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
5587 5588 5589 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5587 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
5597 5598 5599 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5597 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
5604 5605 5606 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5604 def plan @plan end |
#region ⇒ String
[Output Only] URL of the region where this commitment may be used.
Corresponds to the JSON property region
5609 5610 5611 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5609 def region @region end |
#reservations ⇒ Array<Google::Apis::ComputeAlpha::Reservation>
List of reservations in this commitment.
Corresponds to the JSON property reservations
5614 5615 5616 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5614 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
5620 5621 5622 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5620 def resources @resources end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
5625 5626 5627 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5625 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
5630 5631 5632 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5630 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
5635 5636 5637 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5635 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
5640 5641 5642 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5640 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
5647 5648 5649 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5647 def status @status end |
#status_message ⇒ String
[Output Only] An optional, human-readable explanation of the status.
Corresponds to the JSON property statusMessage
5652 5653 5654 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5652 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
5660 5661 5662 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5660 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 5667 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 |