public sealed class CapacityCommitment : IMessage<CapacityCommitment>, IEquatable<CapacityCommitment>, IDeepCloneable<CapacityCommitment>, IBufferMessage, IMessageReference 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.
Implements
IMessageCapacityCommitment, IEquatableCapacityCommitment, IDeepCloneableCapacityCommitment, IBufferMessage, IMessageNamespace
Google.Cloud.BigQuery.Reservation.V1Assembly
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. Note after renewal, commitment_end_time is the time the renewed commitment expires. So it would be at a time after commitment_start_time + committed period, because we don't change commitment_start_time ,
| 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. Note after the commitment is renewed, commitment_start_time won't be changed. It refers to the start time of the original commitment.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Edition
public Edition Edition { get; set; }Edition of the capacity commitment.
| Property Value | |
|---|---|
| Type | Description |
Edition |
|
FailureStatus
public Status FailureStatus { get; set; }Output only. For FAILED commitment plan, provides the reason of failure.
| Property Value | |
|---|---|
| Type | Description |
Status |
|
IsFlatRate
public bool IsFlatRate { get; set; }Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
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.
NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
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 |
CapacityCommitmentTypesCommitmentPlan |
|
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 |
CapacityCommitmentTypesCommitmentPlan |
|
SlotCount
public long SlotCount { get; set; }Number of slots in this commitment.
| Property Value | |
|---|---|
| Type | Description |
long |
|
State
public CapacityCommitment.Types.State State { get; set; }Output only. State of the commitment.
| Property Value | |
|---|---|
| Type | Description |
CapacityCommitmentTypesState |
|