Class Commitment (1.16.1)

Version 1.16.1

• 1.23.0 (latest)
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

Commitment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
auto_renew	bool 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. This field is a member of oneof_ _auto_renew.
category	str 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. This field is a member of oneof_ _category.
creation_timestamp	str [Output Only] Creation timestamp in RFC3339 text format. This field is a member of oneof_ _creation_timestamp.
description	str An optional description of this resource. Provide this property when you create the resource. This field is a member of oneof_ _description.
end_timestamp	str [Output Only] Commitment end time in RFC3339 text format. This field is a member of oneof_ _end_timestamp.
id	int [Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of oneof_ _id.
kind	str [Output Only] Type of the resource. Always compute#commitment for commitments. This field is a member of oneof_ _kind.
license_resource	google.cloud.compute_v1.types.LicenseResourceCommitment The license specification required as part of a license commitment. This field is a member of oneof_ _license_resource.
merge_source_commitments	MutableSequence[str] List of source commitments to be merged into a new commitment.
name	str 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. This field is a member of oneof_ _name.
plan	str 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. This field is a member of oneof_ _plan.
region	str [Output Only] URL of the region where this commitment may be used. This field is a member of oneof_ _region.
reservations	MutableSequence[google.cloud.compute_v1.types.Reservation] List of create-on-create reseravtions for this commitment.
resources	MutableSequence[google.cloud.compute_v1.types.ResourceCommitment] A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
self_link	str [Output Only] Server-defined URL for the resource. This field is a member of oneof_ _self_link.
split_source_commitment	str Source commitment to be split into a new commitment. This field is a member of oneof_ _split_source_commitment.
start_timestamp	str [Output Only] Commitment start time in RFC3339 text format. This field is a member of oneof_ _start_timestamp.
status	str [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. This field is a member of oneof_ _status.
status_message	str [Output Only] An optional, human-readable explanation of the status. This field is a member of oneof_ _status_message.
type_	str 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. This field is a member of oneof_ _type.

Classes

Category

Category(value)

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.

Values: UNDEFINED_CATEGORY (0): A value indicating that the enum field is not set. CATEGORY_UNSPECIFIED (509189462): No description available. LICENSE (347869217): No description available. MACHINE (469553191): No description available.

Plan

Plan(value)

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

Values: UNDEFINED_PLAN (0): A value indicating that the enum field is not set. INVALID (530283991): No description available. THIRTY_SIX_MONTH (266295942): No description available. TWELVE_MONTH (173083962): No description available.

Status

Status(value)

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

Values: UNDEFINED_STATUS (0): A value indicating that the enum field is not set. ACTIVE (314733318): No description available. CANCELLED (41957681): Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation. CREATING (455564985): No description available. EXPIRED (482489093): No description available. NOT_YET_ACTIVE (20607337): No description available.

Type

Type(value)

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.

Values: UNDEFINED_TYPE (0): A value indicating that the enum field is not set. ACCELERATOR_OPTIMIZED (280848403): No description available. ACCELERATOR_OPTIMIZED_A3 (158574526): No description available. COMPUTE_OPTIMIZED (158349023): No description available. COMPUTE_OPTIMIZED_C2D (383246453): No description available. COMPUTE_OPTIMIZED_C3 (428004784): No description available. COMPUTE_OPTIMIZED_C3D (383246484): No description available. COMPUTE_OPTIMIZED_H3 (428004939): No description available. GENERAL_PURPOSE (299793543): No description available. GENERAL_PURPOSE_E2 (301911877): No description available. GENERAL_PURPOSE_N2 (301912156): No description available. GENERAL_PURPOSE_N2D (232471400): No description available. GENERAL_PURPOSE_T2D (232477166): No description available. GRAPHICS_OPTIMIZED (68500563): No description available. MEMORY_OPTIMIZED (281753417): No description available. MEMORY_OPTIMIZED_M3 (276301372): No description available. TYPE_UNSPECIFIED (437714322): No description available.