CapacityCommitment

import type { CapacityCommitment } from "https://googleapis.deno.dev/v1/bigqueryreservation:v1.ts";

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.

interface CapacityCommitment {

readonly commitmentEndTime?: Date;

readonly commitmentStartTime?: Date;

edition?:

| "EDITION_UNSPECIFIED"

| "STANDARD"

| "ENTERPRISE"

| "ENTERPRISE_PLUS";

readonly failureStatus?: Status;

readonly isFlatRate?: boolean;

multiRegionAuxiliary?: boolean;

readonly name?: string;

plan?:

| "COMMITMENT_PLAN_UNSPECIFIED"

| "FLEX"

| "FLEX_FLAT_RATE"

| "TRIAL"

| "MONTHLY"

| "MONTHLY_FLAT_RATE"

| "ANNUAL"

| "ANNUAL_FLAT_RATE"

| "THREE_YEAR"

| "NONE";

renewalPlan?:

| "COMMITMENT_PLAN_UNSPECIFIED"

| "FLEX"

| "FLEX_FLAT_RATE"

| "TRIAL"

| "MONTHLY"

| "MONTHLY_FLAT_RATE"

| "ANNUAL"

| "ANNUAL_FLAT_RATE"

| "THREE_YEAR"

| "NONE";

slotCount?: bigint;

readonly state?:

| "STATE_UNSPECIFIED"

| "PENDING"

| "ACTIVE"

| "FAILED";

}

§Properties

readonly commitmentEndTime?: Date

[src]

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

readonly commitmentStartTime?: Date

[src]

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

edition?: "EDITION_UNSPECIFIED" | "STANDARD" | "ENTERPRISE" | "ENTERPRISE_PLUS"

[src]

Edition of the capacity commitment.

readonly failureStatus?: Status

[src]

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

readonly isFlatRate?: boolean

[src]

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

multiRegionAuxiliary?: boolean

[src]

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.

readonly name?: string

[src]

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.

[src]

Capacity commitment commitment plan.

[src]

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.

slotCount?: bigint

[src]

Number of slots in this commitment.

readonly state?: "STATE_UNSPECIFIED" | "PENDING" | "ACTIVE" | "FAILED"

[src]

Output only. State of the commitment.