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
Implements
Inherited Members
Namespace: Google.Apis.BigQueryReservation.v1beta1.Data
Assembly: Google.Apis.BigQueryReservation.v1beta1.dll
Syntax
public class CapacityCommitment : IDirectResponseSchema
Properties
CommitmentEndTime
Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
Declaration
[JsonProperty("commitmentEndTime")]
public virtual object CommitmentEndTime { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
CommitmentStartTime
Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
Declaration
[JsonProperty("commitmentStartTime")]
public virtual object CommitmentStartTime { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
System.String |
FailureStatus
Output only. For FAILED commitment plan, provides the reason of failure.
Declaration
[JsonProperty("failureStatus")]
public virtual Status FailureStatus { get; set; }
Property Value
Type | Description |
---|---|
Status |
MultiRegionAuxiliary
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.
Declaration
[JsonProperty("multiRegionAuxiliary")]
public virtual bool? MultiRegionAuxiliary { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
Name
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.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Plan
Capacity commitment commitment plan.
Declaration
[JsonProperty("plan")]
public virtual string Plan { get; set; }
Property Value
Type | Description |
---|---|
System.String |
RenewalPlan
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 commitments.
Declaration
[JsonProperty("renewalPlan")]
public virtual string RenewalPlan { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SlotCount
Number of slots in this commitment.
Declaration
[JsonProperty("slotCount")]
public virtual long? SlotCount { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> |
State
Output only. State of the commitment.
Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type | Description |
---|---|
System.String |