Class 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.
Implements
Inherited Members
Namespace: Google.Apis.Compute.beta.Data
Assembly: Google.Apis.Compute.beta.dll
Syntax
public class Commitment : IDirectResponseSchema
Properties
AutoRenew
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.
Declaration
[JsonProperty("autoRenew")]
public virtual bool? AutoRenew { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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.
Declaration
[JsonProperty("category")]
public virtual string Category { get; set; }
Property Value
Type | Description |
---|---|
string |
CreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Type | Description |
---|---|
string |
Description
An optional description of this resource. Provide this property when you create the resource.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EndTimestamp
[Output Only] Commitment end time in RFC3339 text format.
Declaration
[JsonProperty("endTimestamp")]
public virtual string EndTimestamp { get; set; }
Property Value
Type | Description |
---|---|
string |
ExistingReservations
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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
Declaration
[JsonProperty("existingReservations")]
public virtual IList<string> ExistingReservations { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
Id
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Declaration
[JsonProperty("id")]
public virtual ulong? Id { get; set; }
Property Value
Type | Description |
---|---|
ulong? |
Kind
[Output Only] Type of the resource. Always compute#commitment for commitments.
Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type | Description |
---|---|
string |
LicenseResource
The license specification required as part of a license commitment.
Declaration
[JsonProperty("licenseResource")]
public virtual LicenseResourceCommitment LicenseResource { get; set; }
Property Value
Type | Description |
---|---|
LicenseResourceCommitment |
MergeSourceCommitments
List of source commitments to be merged into a new commitment.
Declaration
[JsonProperty("mergeSourceCommitments")]
public virtual IList<string> MergeSourceCommitments { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
Name
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.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
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).
Declaration
[JsonProperty("plan")]
public virtual string Plan { get; set; }
Property Value
Type | Description |
---|---|
string |
Region
[Output Only] URL of the region where this commitment may be used.
Declaration
[JsonProperty("region")]
public virtual string Region { get; set; }
Property Value
Type | Description |
---|---|
string |
Reservations
List of create-on-create reservations for this commitment.
Declaration
[JsonProperty("reservations")]
public virtual IList<Reservation> Reservations { get; set; }
Property Value
Type | Description |
---|---|
IList<Reservation> |
Resources
A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
Declaration
[JsonProperty("resources")]
public virtual IList<ResourceCommitment> Resources { get; set; }
Property Value
Type | Description |
---|---|
IList<ResourceCommitment> |
SelfLink
[Output Only] Server-defined URL for the resource.
Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type | Description |
---|---|
string |
SplitSourceCommitment
Source commitment to be split into a new commitment.
Declaration
[JsonProperty("splitSourceCommitment")]
public virtual string SplitSourceCommitment { get; set; }
Property Value
Type | Description |
---|---|
string |
StartTimestamp
[Output Only] Commitment start time in RFC3339 text format.
Declaration
[JsonProperty("startTimestamp")]
public virtual string StartTimestamp { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type | Description |
---|---|
string |
StatusMessage
[Output Only] An optional, human-readable explanation of the status.
Declaration
[JsonProperty("statusMessage")]
public virtual string StatusMessage { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type | Description |
---|---|
string |