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
Inherited Members
Namespace: Google.Apis.BigQueryReservation.v1.Data
Assembly: Google.Apis.BigQueryReservation.v1.dll
Syntax
public class CapacityCommitment : IDirectResponseSchema

Properties

CommitmentEndTime

object representation of CommitmentEndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CommitmentEndTimeDateTimeOffset instead.")]
public virtual object CommitmentEndTime { get; set; }
Property Value
Type Description
object

CommitmentEndTimeDateTimeOffset

DateTimeOffset representation of CommitmentEndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CommitmentEndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CommitmentEndTimeRaw

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 itwould be at a time after commitment_start_time + committed period, because we don't change commitment_start_time ,

Declaration
[JsonProperty("commitmentEndTime")]
public virtual string CommitmentEndTimeRaw { get; set; }
Property Value
Type Description
string

CommitmentStartTime

object representation of CommitmentStartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CommitmentStartTimeDateTimeOffset instead.")]
public virtual object CommitmentStartTime { get; set; }
Property Value
Type Description
object

CommitmentStartTimeDateTimeOffset

DateTimeOffset representation of CommitmentStartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CommitmentStartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CommitmentStartTimeRaw

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.

Declaration
[JsonProperty("commitmentStartTime")]
public virtual string CommitmentStartTimeRaw { 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

Edition

Optional. Edition of the capacity commitment.

Declaration
[JsonProperty("edition")]
public virtual string Edition { get; set; }
Property Value
Type Description
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

IsFlatRate

Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.

Declaration
[JsonProperty("isFlatRate")]
public virtual bool? IsFlatRate { get; set; }
Property Value
Type Description
bool?

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. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.

Declaration
[JsonProperty("multiRegionAuxiliary")]
public virtual bool? MultiRegionAuxiliary { get; set; }
Property Value
Type Description
bool?

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
string

Plan

Optional. Capacity commitment commitment plan.

Declaration
[JsonProperty("plan")]
public virtual string Plan { get; set; }
Property Value
Type Description
string

RenewalPlan

Optional. 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.

Declaration
[JsonProperty("renewalPlan")]
public virtual string RenewalPlan { get; set; }
Property Value
Type Description
string

SlotCount

Optional. Number of slots in this commitment.

Declaration
[JsonProperty("slotCount")]
public virtual long? SlotCount { get; set; }
Property Value
Type Description
long?

State

Output only. State of the commitment.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Implements