BigQuery Reservation v1 API - Class CapacityCommitment (2.1.0)

public sealed class CapacityCommitment : IMessage<CapacityCommitment>, IEquatable<CapacityCommitment>, IDeepCloneable<CapacityCommitment>, IBufferMessage, IMessage

Reference documentation and code samples for the BigQuery Reservation v1 API class CapacityCommitment.

Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes.

In order to remove annual commitment, its plan needs to be changed to monthly or flex first.

A capacity commitment resource exists as a child resource of the admin project.

Inheritance

Object > CapacityCommitment

Implements

IMessage<CapacityCommitment>, IEquatable<CapacityCommitment>, IDeepCloneable<CapacityCommitment>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.BigQuery.Reservation.V1

Assembly

Google.Cloud.BigQuery.Reservation.V1.dll

Constructors

CapacityCommitment()

public CapacityCommitment()

CapacityCommitment(CapacityCommitment)

public CapacityCommitment(CapacityCommitment other)

Parameter
Name	Description
`other`	`CapacityCommitment`

Properties

CapacityCommitmentName

public CapacityCommitmentName CapacityCommitmentName { get; set; }

CapacityCommitmentName-typed view over the Name resource name property.

Property Value
Type	Description
`CapacityCommitmentName`

CommitmentEndTime

public Timestamp CommitmentEndTime { get; set; }

Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.

Property Value
Type	Description
`Timestamp`

CommitmentStartTime

public Timestamp CommitmentStartTime { get; set; }

Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.

Property Value
Type	Description
`Timestamp`

FailureStatus

public Status FailureStatus { get; set; }

Output only. For FAILED commitment plan, provides the reason of failure.

Property Value
Type	Description
`Status`

MultiRegionAuxiliary

public bool MultiRegionAuxiliary { get; set; }

Applicable only for commitments located within one of the BigQuery multi-regions (US or EU).

If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region.

Property Value
Type	Description
`Boolean`

Name

public string Name { get; set; }

Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 The commitment_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.

Property Value
Type	Description
`String`

Plan

public CapacityCommitment.Types.CommitmentPlan Plan { get; set; }

Capacity commitment commitment plan.

Property Value
Type	Description
`CapacityCommitment.Types.CommitmentPlan`

RenewalPlan

public CapacityCommitment.Types.CommitmentPlan RenewalPlan { get; set; }

The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.

Property Value
Type	Description
`CapacityCommitment.Types.CommitmentPlan`

SlotCount

public long SlotCount { get; set; }

Number of slots in this commitment.

Property Value
Type	Description
`Int64`

State

public CapacityCommitment.Types.State State { get; set; }

Output only. State of the commitment.

Property Value
Type	Description
`CapacityCommitment.Types.State`