Class: Google::Apis::ComputeAlpha::Commitment

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
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 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



3510
3511
3512
# File 'generated/google/apis/compute_alpha/classes.rb', line 3510

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#creation_timestampString

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String)


3429
3430
3431
# File 'generated/google/apis/compute_alpha/classes.rb', line 3429

def creation_timestamp
  @creation_timestamp
end

#descriptionString

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String)


3435
3436
3437
# File 'generated/google/apis/compute_alpha/classes.rb', line 3435

def description
  @description
end

#end_timestampString

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

Returns:

  • (String)


3440
3441
3442
# File 'generated/google/apis/compute_alpha/classes.rb', line 3440

def end_timestamp
  @end_timestamp
end

#idFixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum)


3446
3447
3448
# File 'generated/google/apis/compute_alpha/classes.rb', line 3446

def id
  @id
end

#kindString

[Output Only] Type of the resource. Always compute#commitment for commitments. Corresponds to the JSON property kind

Returns:

  • (String)


3451
3452
3453
# File 'generated/google/apis/compute_alpha/classes.rb', line 3451

def kind
  @kind
end

#nameString

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)


3461
3462
3463
# File 'generated/google/apis/compute_alpha/classes.rb', line 3461

def name
  @name
end

#planString

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)


3468
3469
3470
# File 'generated/google/apis/compute_alpha/classes.rb', line 3468

def plan
  @plan
end

#regionString

[Output Only] URL of the region where this commitment may be used. Corresponds to the JSON property region

Returns:

  • (String)


3473
3474
3475
# File 'generated/google/apis/compute_alpha/classes.rb', line 3473

def region
  @region
end

#resourcesArray<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



3479
3480
3481
# File 'generated/google/apis/compute_alpha/classes.rb', line 3479

def resources
  @resources
end

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

Returns:

  • (String)


3484
3485
3486
# File 'generated/google/apis/compute_alpha/classes.rb', line 3484

def self_link
  @self_link
end

#start_timestampString

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

Returns:

  • (String)


3489
3490
3491
# File 'generated/google/apis/compute_alpha/classes.rb', line 3489

def start_timestamp
  @start_timestamp
end

#statusString

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


3496
3497
3498
# File 'generated/google/apis/compute_alpha/classes.rb', line 3496

def status
  @status
end

#status_messageString

[Output Only] An optional, human-readable explanation of the status. Corresponds to the JSON property statusMessage

Returns:

  • (String)


3501
3502
3503
# File 'generated/google/apis/compute_alpha/classes.rb', line 3501

def status_message
  @status_message
end

#typeString

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

Returns:

  • (String)


3508
3509
3510
# File 'generated/google/apis/compute_alpha/classes.rb', line 3508

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
# File 'generated/google/apis/compute_alpha/classes.rb', line 3515

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)
  @type = args[:type] if args.key?(:type)
end