REST リソース: projects.locations.capacityCommitments

リソース: CapacityCommitment

容量コミットメントは、commit された使用期間で BigQuery ジョブのコンピューティング容量を(スロット形式で)購入する方法です。年間コミットメントはデフォルトで更新されます。コミットメントは、コミットメントの終了時間を過ぎたら削除できます。

年間コミットメントを削除するには、まず、マンスリー プランまたはフレキシブル プランに変更する必要があります。

容量コミットメントのリソースは、管理プロジェクトの子リソースになります。

JSON 表現

{
  "name": string,
  "slotCount": string,
  "plan": enum (CommitmentPlan),
  "state": enum (State),
  "commitmentEndTime": string,
  "failureStatus": {
    object (Status)
  },
  "renewalPlan": enum (CommitmentPlan)
}
フィールド
name

string

出力のみ。容量コミットメントのリソース名。たとえば、projects/myproject/locations/US/capacityCommitments/123

slotCount

string (int64 format)

このコミットメント内のスロット数。

plan

enum (CommitmentPlan)

容量コミットメントのコミットメント プラン。

state

enum (State)

出力のみ。コミットメントの状態。

commitmentEndTime

string (Timestamp format)

出力のみ。現在のコミットメント期間の終了。有効な容量コミットメントにのみ適用されます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

failureStatus

object (Status)

出力のみ。失敗したコミットメント プランの場合は、失敗の理由を示します。

renewalPlan

enum (CommitmentPlan)

この容量コミットメントが commitmentEndTime 経過後に変換されるプラン。プランが変更されると、コミットメント プランに従って commit 期間が延長されます。年間コミットメントとトライアル コミットメントにのみ適用されます。

CommitmentPlan

コミットメント プランは、現在の commit 期間を定義します。commit 期間中は容量コミットメントを削除できません。

列挙型
COMMITMENT_PLAN_UNSPECIFIED 無効なプラン値です。この値を持つリクエストは、エラーコード google.rpc.Code.INVALID_ARGUMENT によって拒否されます。
FLEX フレキシブル コミットメントでは、ACTIVE になってから 1 分間 commit 期間が継続します。その後は、commit 期間が終了し、いつでも削除できます。
TRIAL トライアル コミットメントの commit 期間は、ACTIVE になってから 182 日間です。その後、renewalPlan に基づいて新しいコミットメントに変換されます。トライアル コミットメントのデフォルトの renewalPlan はフレキシブルであるため、commit 期間が終了した直後に削除できます。
MONTHLY 月間コミットメントでは、ACTIVE になってから 30 日間 commit 期間が継続します。その後は、commit 期間が終了し、いつでも削除できます。
ANNUAL 年間コミットメントでは、ACTIVE になってから 365 日間 commit 期間が継続します。その後、renewalPlan に基づいて新しいコミットメントに変換されます。

State

容量コミットメントはすぐに ACTIVE になるか、PENDING から ACTIVE または FAILED に移行します。

列挙型
STATE_UNSPECIFIED 無効なステータス値です。
PENDING 容量コミットメントはプロビジョニングの保留中です。保留中の容量コミットメントによる、親の slotCapacity への影響はありません。
ACTIVE スロットがプロビジョニングされると、容量コミットメントがアクティブになります。slotCount が親の slotCapacity に追加されます。
FAILED バックエンドで容量コミットメントを有効にできませんでした。

メソッド

create

新しい容量コミットメント リソースを作成します。

delete

容量コミットメントを削除します。

get

容量コミットメントに関する情報を返します。

list

管理プロジェクトのすべての容量コミットメントを一覧表示します。

merge

同じプランの容量コミットメントを 1 つのコミットメントに結合します。

patch

既存の容量コミットメントを更新します。

split

容量コミットメントを同じプランの 2 つのコミットメントと commit_end_time に分割します。