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

Inherits:
Object
  • Object
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

Instance Attribute Details

#auto_renew::Boolean

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

Returns:

  • (::Boolean)

    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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  end
end

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



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  end
end

#creation_timestamp::String

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

Returns:

  • (::String)

    [Output Only] Creation timestamp in RFC3339 text format.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  end
end

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

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

Returns:



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  end
end

#merge_source_commitments::Array<::String>

Returns List of source commitments to be merged into a new commitment.

Returns:

  • (::Array<::String>)

    List of source commitments to be merged into a new commitment.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  end
end

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

Returns List of reservations in this commitment.

Returns:



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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:



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  end
end

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

Returns:

  • (::String)

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



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  end
end

#split_source_commitment::String

Returns Source commitment to be split into a new commitment.

Returns:

  • (::String)

    Source commitment to be split into a new commitment.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  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.



4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4282

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 = 509_189_462

    LICENSE = 347_869_217

    MACHINE = 469_553_191
  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 = 530_283_991

    THIRTY_SIX_MONTH = 266_295_942

    TWELVE_MONTH = 173_083_962
  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 = 314_733_318

    # Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
    CANCELLED = 41_957_681

    CREATING = 455_564_985

    EXPIRED = 482_489_093

    NOT_YET_ACTIVE = 20_607_337
  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 = 280_848_403

    COMPUTE_OPTIMIZED = 158_349_023

    COMPUTE_OPTIMIZED_C2D = 383_246_453

    COMPUTE_OPTIMIZED_C3 = 428_004_784

    GENERAL_PURPOSE = 299_793_543

    GENERAL_PURPOSE_E2 = 301_911_877

    GENERAL_PURPOSE_N2 = 301_912_156

    GENERAL_PURPOSE_N2D = 232_471_400

    GENERAL_PURPOSE_T2D = 232_477_166

    GRAPHICS_OPTIMIZED = 68_500_563

    MEMORY_OPTIMIZED = 281_753_417

    MEMORY_OPTIMIZED_M3 = 276_301_372

    TYPE_UNSPECIFIED = 437_714_322
  end
end