public sealed class Commitment : IMessage<Commitment>, IEquatable<Commitment>, IDeepCloneable<Commitment>, IBufferMessage, IMessageReference documentation and code samples for the Compute Engine v1 API class Commitment.
Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts
Implements
IMessageCommitment, IEquatableCommitment, IDeepCloneableCommitment, IBufferMessage, IMessageNamespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Constructors
Commitment()
public Commitment()Commitment(Commitment)
public Commitment(Commitment other)| Parameter | |
|---|---|
| Name | Description |
other |
Commitment |
Properties
AutoRenew
public bool AutoRenew { get; set; }Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Category
public string Category { get; set; }The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. Check the Category enum for the list of possible values.
| Property Value | |
|---|---|
| Type | Description |
string |
|
CreationTimestamp
public string CreationTimestamp { get; set; }[Output Only] Creation timestamp in RFC3339 text format.
| Property Value | |
|---|---|
| Type | Description |
string |
|
CustomEndTimestamp
public string CustomEndTimestamp { get; set; }[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Description
public string Description { get; set; }An optional description of the commitment. You can provide this property when you create the resource.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EndTimestamp
public string EndTimestamp { get; set; }[Output Only] Commitment end time in RFC3339 text format.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ExistingReservations
public RepeatedField<string> ExistingReservations { get; }| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
HasAutoRenew
public bool HasAutoRenew { get; }Gets whether the "auto_renew" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasCategory
public bool HasCategory { get; }Gets whether the "category" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasCreationTimestamp
public bool HasCreationTimestamp { get; }Gets whether the "creation_timestamp" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasCustomEndTimestamp
public bool HasCustomEndTimestamp { get; }Gets whether the "custom_end_timestamp" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasDescription
public bool HasDescription { get; }Gets whether the "description" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasEndTimestamp
public bool HasEndTimestamp { get; }Gets whether the "end_timestamp" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasId
public bool HasId { get; }Gets whether the "id" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasKind
public bool HasKind { get; }Gets whether the "kind" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasName
public bool HasName { get; }Gets whether the "name" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasPlan
public bool HasPlan { get; }Gets whether the "plan" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasRegion
public bool HasRegion { get; }Gets whether the "region" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSelfLink
public bool HasSelfLink { get; }Gets whether the "self_link" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSplitSourceCommitment
public bool HasSplitSourceCommitment { get; }Gets whether the "split_source_commitment" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasStartTimestamp
public bool HasStartTimestamp { get; }Gets whether the "start_timestamp" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasStatus
public bool HasStatus { get; }Gets whether the "status" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasStatusMessage
public bool HasStatusMessage { get; }Gets whether the "status_message" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasType
public bool HasType { get; }Gets whether the "type" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Id
public ulong Id { get; set; }[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Property Value | |
|---|---|
| Type | Description |
ulong |
|
Kind
public string Kind { get; set; }[Output Only] Type of the resource. Always compute#commitment for commitments.
| Property Value | |
|---|---|
| Type | Description |
string |
|
LicenseResource
public LicenseResourceCommitment LicenseResource { get; set; }The license specification required as part of a license commitment.
| Property Value | |
|---|---|
| Type | Description |
LicenseResourceCommitment |
|
MergeSourceCommitments
public RepeatedField<string> MergeSourceCommitments { get; }The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
Name
public string Name { get; set; }Name of the commitment. You must specify a name when you purchase the commitment. 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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Plan
public string Plan { get; set; }The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Check the Plan enum for the list of possible values.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Region
public string Region { get; set; }[Output Only] URL of the region where the commitment and committed resources are located.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Reservations
public RepeatedField<Reservation> Reservations { get; }The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldReservation |
|
ResourceStatus
public CommitmentResourceStatus ResourceStatus { get; set; }[Output Only] Status information for Commitment resource.
| Property Value | |
|---|---|
| Type | Description |
CommitmentResourceStatus |
|
Resources
public RepeatedField<ResourceCommitment> Resources { get; }The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldResourceCommitment |
|
SelfLink
public string SelfLink { get; set; }[Output Only] Server-defined URL for the resource.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SplitSourceCommitment
public string SplitSourceCommitment { get; set; }The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
| Property Value | |
|---|---|
| Type | Description |
string |
|
StartTimestamp
public string StartTimestamp { get; set; }[Output Only] Commitment start time in RFC3339 text format.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Status
public string Status { get; set; }[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. Check the Status enum for the list of possible values.
| Property Value | |
|---|---|
| Type | Description |
string |
|
StatusMessage
public string StatusMessage { get; set; }[Output Only] An optional, human-readable explanation of the status.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Type
public string Type { get; set; }The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. Check the Type enum for the list of possible values.
| Property Value | |
|---|---|
| Type | Description |
string |
|