Class: Google::Cloud::Compute::V1::Commitment

Inherits:

Object

Object
Google::Cloud::Compute::V1::Commitment

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/compute/v1/compute.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.

Defined Under Namespace

Modules: Category, Plan, Status, Type

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 ⇒ ::Integer
[Output Only] The unique identifier for the resource.
#kind ⇒ ::String
[Output Only] Type of the resource.
#license_resource ⇒ ::Google::Cloud::Compute::V1::LicenseResourceCommitment
The license specification required as part of a license 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::Cloud::Compute::V1::Reservation>
List of reservations in this commitment.
#resources ⇒ ::Array<::Google::Cloud::Compute::V1::ResourceCommitment>
A list of commitment amounts for particular resources.
#self_link ⇒ ::String
[Output Only] Server-defined URL for the resource.
#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 Attribute Details

#category ⇒ `::String`

Returns 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. Check the Category enum for the list of possible values.

Returns:

(::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. Check the Category enum for the list of possible values.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#creation_timestamp ⇒ `::String`

Returns [Output Only] Creation timestamp in RFC3339 text format.

Returns:

(::String) —
[Output Only] Creation timestamp in RFC3339 text format.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#description ⇒ `::String`

Returns An optional description of this resource. Provide this property when you create the resource.

Returns:

(::String) —
An optional description of this resource. Provide this property when you create the resource.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#end_timestamp ⇒ `::String`

Returns [Output Only] Commitment end time in RFC3339 text format.

Returns:

(::String) —
[Output Only] Commitment end time in RFC3339 text format.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#id ⇒ `::Integer`

Returns [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:

(::Integer) —
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#kind ⇒ `::String`

Returns [Output Only] Type of the resource. Always compute#commitment for commitments.

Returns:

(::String) —
[Output Only] Type of the resource. Always compute#commitment for commitments.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#license_resource ⇒ `::Google::Cloud::Compute::V1::LicenseResourceCommitment`

Returns The license specification required as part of a license commitment.

Returns:

(::Google::Cloud::Compute::V1::LicenseResourceCommitment) —
The license specification required as part of a license commitment.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#name ⇒ `::String`

Returns 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.

Returns:

(::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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#plan ⇒ `::String`

Returns 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). Check the Plan enum for the list of possible values.

Returns:

(::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). Check the Plan enum for the list of possible values.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#region ⇒ `::String`

Returns [Output Only] URL of the region where this commitment may be used.

Returns:

(::String) —
[Output Only] URL of the region where this commitment may be used.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#reservations ⇒ `::Array<::Google::Cloud::Compute::V1::Reservation>`

Returns List of reservations in this commitment.

Returns:

(::Array<::Google::Cloud::Compute::V1::Reservation>) —
List of reservations in this commitment.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#resources ⇒ `::Array<::Google::Cloud::Compute::V1::ResourceCommitment>`

Returns A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

Returns:

(::Array<::Google::Cloud::Compute::V1::ResourceCommitment>) —
A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#self_link ⇒ `::String`

Returns [Output Only] Server-defined URL for the resource.

Returns:

(::String) —
[Output Only] Server-defined URL for the resource.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#start_timestamp ⇒ `::String`

Returns [Output Only] Commitment start time in RFC3339 text format.

Returns:

(::String) —
[Output Only] Commitment start time in RFC3339 text format.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#status ⇒ `::String`

Returns [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. Check the Status enum for the list of possible values.

Returns:

(::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. Check the Status enum for the list of possible values.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#status_message ⇒ `::String`

Returns [Output Only] An optional, human-readable explanation of the status.

Returns:

(::String) —
[Output Only] An optional, human-readable explanation of the status.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

#type ⇒ `::String`

Returns 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. Check the Type enum for the list of possible values.

Returns:

(::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. Check the Type enum for the list of possible values.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 3351

class Commitment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module Category
    # A value indicating that the enum field is not set.
    UNDEFINED_CATEGORY = 0

    CATEGORY_UNSPECIFIED = 509189462

    LICENSE = 347869217

    MACHINE = 469553191
  end

  # 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).
  module Plan
    # A value indicating that the enum field is not set.
    UNDEFINED_PLAN = 0

    INVALID = 530283991

    THIRTY_SIX_MONTH = 266295942

    TWELVE_MONTH = 173083962
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    ACTIVE = 314733318

    CREATING = 455564985

    EXPIRED = 482489093

    NOT_YET_ACTIVE = 20607337
  end

  # 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.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    ACCELERATOR_OPTIMIZED = 280848403

    COMPUTE_OPTIMIZED = 158349023

    GENERAL_PURPOSE = 299793543

    GENERAL_PURPOSE_E2 = 301911877

    GENERAL_PURPOSE_N2 = 301912156

    GENERAL_PURPOSE_N2D = 232471400

    MEMORY_OPTIMIZED = 281753417

    TYPE_UNSPECIFIED = 437714322
  end
end

Class: Google::Cloud::Compute::V1::Commitment

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#category ⇒ ::String

#creation_timestamp ⇒ ::String

#description ⇒ ::String

#end_timestamp ⇒ ::String

#id ⇒ ::Integer

#kind ⇒ ::String

#license_resource ⇒ ::Google::Cloud::Compute::V1::LicenseResourceCommitment

#name ⇒ ::String

#plan ⇒ ::String

#region ⇒ ::String

#reservations ⇒ ::Array<::Google::Cloud::Compute::V1::Reservation>

#resources ⇒ ::Array<::Google::Cloud::Compute::V1::ResourceCommitment>

#self_link ⇒ ::String

#start_timestamp ⇒ ::String

#status ⇒ ::String

#status_message ⇒ ::String

#type ⇒ ::String

#category ⇒ `::String`

#creation_timestamp ⇒ `::String`

#description ⇒ `::String`

#end_timestamp ⇒ `::String`

#id ⇒ `::Integer`

#kind ⇒ `::String`

#license_resource ⇒ `::Google::Cloud::Compute::V1::LicenseResourceCommitment`

#name ⇒ `::String`

#plan ⇒ `::String`

#region ⇒ `::String`

#reservations ⇒ `::Array<::Google::Cloud::Compute::V1::Reservation>`

#resources ⇒ `::Array<::Google::Cloud::Compute::V1::ResourceCommitment>`

#self_link ⇒ `::String`

#start_timestamp ⇒ `::String`

#status ⇒ `::String`

#status_message ⇒ `::String`

#type ⇒ `::String`