REST Resource: regionCommitments

Resource: Commitment

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.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "selfLink": string,
  "status": enum (Status),
  "statusMessage": string,
  "plan": enum (Plan),
  "startTimestamp": string,
  "endTimestamp": string,
  "resources": [
    {
      object (ResourceCommitment)
    }
  ],
  "type": enum (Type),
  "reservations": [
    {
      object (Reservation)
    }
  ],
  "category": enum (Category),
  "licenseResource": {
    object (LicenseResourceCommitment)
  },
  "autoRenew": boolean,
  "mergeSourceCommitments": [
    string
  ],
  "splitSourceCommitment": string,
  "resourceStatus": {
    object (ResourceStatus)
  },
  "existingReservations": [
    string
  ],
  "customEndTimestamp": string
}
Fields
kind

string

[Output Only] Type of the resource. Always

compute#commitment

for commitments.
id

string (uint64 format)

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

string

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

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description

string

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

string

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

enum (Status)

[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

.
statusMessage

string

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

enum (Plan)

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

string

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

string

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

object (ResourceCommitment)

A list of commitment amounts for particular resources. Note that

VCPU

and

MEMORY

resource commitments must occur together.
type

enum (Type)

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

object (Reservation)

regionCommitments.list of create-on-create reservations for this commitment.
category

enum (Category)

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

object (LicenseResourceCommitment)

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

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

string

regionCommitments.list of source commitments to be merged into a new commitment.
splitSourceCommitment

string

Source commitment to be split into a new commitment.
resourceStatus

object (ResourceStatus)

[Output Only] Status information for Commitment resource.
existingReservations[]

string

Specifies the already existing reservations to attach to the Commitment.

This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation:

customEndTimestamp

string

[Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.

Status

Status of a commitment with regards to eventual expiration (each commitment has an end date defined).

Enums
CREATING
ACTIVE
EXPIRED
NOT_YET_ACTIVE
CANCELLED Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.

Plan

Plan (may affect e.g. discount)

Enums
INVALID
TWELVE_MONTH
THIRTY_SIX_MONTH

ResourceCommitment

Commitment for a particular resource (a Commitment is composed of one or more of these).

JSON representation 
{
  "type": enum (Type),
  "amount": string,
  "acceleratorType": string
}
Fields
type

enum (Type)

Type of resource for which this commitment applies. Possible values are

VCPU

,

MEMORY

,

LOCAL_SSD

, and

ACCELERATOR

.
amount

string (int64 format)

The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
acceleratorType

string

Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.

Type

Type of resource for which a commitment applies.

Enums
UNSPECIFIED
VCPU
MEMORY
LOCAL_SSD
ACCELERATOR

Type

next ID: 39

Enums
TYPE_UNSPECIFIED
GENERAL_PURPOSE
MEMORY_OPTIMIZED
COMPUTE_OPTIMIZED
GENERAL_PURPOSE_N2
GENERAL_PURPOSE_E2
GENERAL_PURPOSE_N2D
ACCELERATOR_OPTIMIZED
COMPUTE_OPTIMIZED_C2D
GENERAL_PURPOSE_T2D
COMPUTE_OPTIMIZED_C3
MEMORY_OPTIMIZED_M3
ACCELERATOR_OPTIMIZED_A3
GRAPHICS_OPTIMIZED
COMPUTE_OPTIMIZED_C3D
COMPUTE_OPTIMIZED_H3
GENERAL_PURPOSE_C4
GENERAL_PURPOSE_N4
STORAGE_OPTIMIZED_Z3
GENERAL_PURPOSE_C4A
ACCELERATOR_OPTIMIZED_A3_MEGA
MEMORY_OPTIMIZED_X4_16TB
MEMORY_OPTIMIZED_X4_24TB
MEMORY_OPTIMIZED_X4_32TB

Category

Enums
CATEGORY_UNSPECIFIED
MACHINE
LICENSE

LicenseResourceCommitment

Commitment for a particular license resource.

JSON representation 
{
  "license": string,
  "amount": string,
  "coresPerLicense": string
}
Fields
license

string

Any applicable license URI.
amount

string (int64 format)

The number of licenses purchased.
coresPerLicense

string

Specifies the core range of the instance for which this license applies.

ResourceStatus

[Output Only] Contains output only fields.

JSON representation 
{
  "customTermEligibilityEndTimestamp": string
}
Fields
customTermEligibilityEndTimestamp

string

[Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.

Methods

aggregatedList

 The method compute.v1.RegionCommitmentsService.AggregatedList is not available in this (s3nsapis.fr) universe.

get

 The method compute.v1.RegionCommitmentsService.Get is not available in this (s3nsapis.fr) universe.

insert

 The method compute.v1.RegionCommitmentsService.Insert is not available in this (s3nsapis.fr) universe.

list

 The method compute.v1.RegionCommitmentsService.List is not available in this (s3nsapis.fr) universe.

update

 The method compute.v1.RegionCommitmentsService.Update is not available in this (s3nsapis.fr) universe.