Class: Google::Apis::ComputeAlpha::Commitment
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Commitment
- 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 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. (== resource_for $api_version
.
regionCommitments ==)
Instance Attribute Summary collapse
-
#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.
-
#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.
-
#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.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Commitment
Returns a new instance of Commitment.
4523 4524 4525 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4523 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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
4422 4423 4424 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4422 def category @category end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
4427 4428 4429 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4427 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
4433 4434 4435 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4433 def description @description end |
#end_timestamp ⇒ String
[Output Only] Commitment end time in RFC3339 text format.
Corresponds to the JSON property endTimestamp
4438 4439 4440 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4438 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
4444 4445 4446 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4444 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#commitment for commitments.
Corresponds to the JSON property kind
4449 4450 4451 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4449 def kind @kind end |
#license_resource ⇒ Google::Apis::ComputeAlpha::LicenseResourceCommitment
Commitment for a particular license resource.
Corresponds to the JSON property licenseResource
4454 4455 4456 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4454 def license_resource @license_resource 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
4464 4465 4466 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4464 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
4471 4472 4473 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4471 def plan @plan end |
#region ⇒ String
[Output Only] URL of the region where this commitment may be used.
Corresponds to the JSON property region
4476 4477 4478 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4476 def region @region end |
#reservations ⇒ Array<Google::Apis::ComputeAlpha::Reservation>
List of reservations in this commitment.
Corresponds to the JSON property reservations
4481 4482 4483 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4481 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
4487 4488 4489 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4487 def resources @resources end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
4492 4493 4494 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4492 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
4497 4498 4499 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4497 def self_link_with_id @self_link_with_id end |
#start_timestamp ⇒ String
[Output Only] Commitment start time in RFC3339 text format.
Corresponds to the JSON property startTimestamp
4502 4503 4504 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4502 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
4509 4510 4511 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4509 def status @status end |
#status_message ⇒ String
[Output Only] An optional, human-readable explanation of the status.
Corresponds to the JSON property statusMessage
4514 4515 4516 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4514 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.
Corresponds to the JSON property type
4521 4522 4523 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4521 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4528 def update!(**args) @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) @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) @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 |