REST Resource: projects.locations.rollouts

リソース: Rollout

単一のロールアウト実行とその結果を表します

JSON 表現 
{
  "name": string,
  "release": string,
  "startTime": string,
  "endTime": string,
  "state": enum (RolloutState),
  "stateMessage": string,
  "stateTransitionTime": string,
  "rootRollout": string,
  "parentRollout": string,
  "rolloutOrchestrationStrategy": string,
  "unitFilter": string,
  "rolloutKind": string,
  "stats": {
    object (RolloutStats)
  },
  "control": {
    object (RolloutControl)
  },
  "effectiveUnitFilter": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string
}
フィールド
name

string

ID。標準の命名スキームに沿ったリソース名（リソースの完全な URI）。

"projects/{project}/locations/{location}/rollout/{rolloutId}"
release

string

省略可。変更不可。ターゲット ユニットにロールアウトされるリリースの名前。他のリリースのタイプが指定されていない場合は必須です。
startTime

string (Timestamp format)

省略可。出力専用。ロールアウトの実行が開始された時刻。ロールアウトがまだ開始されていない場合は空になります。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
endTime

string (Timestamp format)

省略可。出力専用。ロールアウトの実行が終了した時刻（成功、失敗、キャンセルに関係なく）。ロールアウトがまだ完了していない場合は空になります。設定すると、ロールアウトは最終状態になり、すべての結果が最終的なものになります。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
state

enum (RolloutState)

出力専用。ロールアウトの現在の状態。
stateMessage

string

出力専用。最後の状態遷移の詳細を示す人間が読めるメッセージ。
stateTransitionTime

string (Timestamp format)

省略可。出力専用。ロールアウトが現在の状態に移行した時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
rootRollout

string

省略可。出力専用。このロールアウトの元となるルート ロールアウト。標準の命名スキームに沿ったリソース名（リソースの完全な URI）。

"projects/{project}/locations/{location}/rollouts/{rolloutId}"
parentRollout

string

省略可。出力専用。このロールアウトの直接の親ロールアウト。標準の命名スキームに沿ったリソース名（リソースの完全な URI）。

"projects/{project}/locations/{location}/rollouts/{rolloutId}"
rolloutOrchestrationStrategy

string

省略可。このロールアウトの実行に使用される戦略。この戦略は、RolloutKind で指定された戦略よりも優先されます。作成時に指定されていない場合は、RolloutKind の戦略が使用されます。

制御に使用される 2 つのサポートされている値の戦略があります。- "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime"

これらのシンプルな戦略のいずれかを使用したロールアウトは、ターゲットの UnitKind の Saas ロケーションで定義されているすべてのロケーションにロールアウトされます。
unitFilter

string

省略可。Unit に対する CEL（https://github.com/google/cel-spec）形式のフィルタ文字列。フィルタが適用され、対象となるユニットの人口が決定されます。このフィルタは、ロールアウトの範囲を縮小することのみが可能で、拡大することはできません。指定しない場合、RolloutKind の unitFilter が使用されます。
rolloutKind

string

省略可。変更不可。このロールアウトの元となる RolloutKind の名前。
stats

object (RolloutStats)

省略可。出力専用。ロールアウトの進行状況に関する詳細。
control

object (RolloutControl)

省略可。このロールアウトの実行に対する変更がリクエストされました。デフォルトの RolloutControl.action は ROLLOUT_ACTION_RUN です。これは、すべての自然なロールアウト状態（RUNNING -> SUCCEEDED や RUNNING -> FAILED など）を進行しながら、ロールアウトが完了まで実行されることを意味します。リクエストは、ロールアウトが終了状態でない場合にのみ行うことができます。
effectiveUnitFilter

string

省略可。出力専用。ロールアウトの開始時刻における有効なユニット フィルタのスナップショット（出力専用）。Rollout.unit_filter と RolloutKind.unit_filter の論理積で構成される CEL（https://github.com/google/cel-spec）式が含まれます。このフィールドには、ロールアウトによって適用されたフィルタが記録され、ユニットの人口が特定されます。ロールアウトの開始後に、関連付けられた RolloutKind の unitFilter が変更されても、ここでは更新されません。
labels

map (key: string, value: string)

省略可。リソースのラベル。分類に使用できます。Kubernetes リソースラベルに似ています。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
annotations

map (key: string, value: string)

省略可。アノテーションは、任意のメタデータを保存して取得するため、外部ツールによって設定される可能性のあるリソースとともに保存される非構造化 Key-Value マップです。クエリは実行可能ではなく、オブジェクトを変更する際に保持する必要があります。

詳細: https://kubernetes.io/docs/user-guide/annotations

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
uid

string

出力専用。リソースの一意の識別子。UID は、サービスのスコープ内で、このリソースの時間と場所において一意性を持ちます。通常は、リソースの作成時にサーバーによって生成され、変更されることはありません。UID は、リソース名が再利用される場合でも一意にリソースを識別するために使用されます。UUID4 であることが必要です。
etag

string

出力専用。リソースのバージョンまたは世代を一意に識別する、不透明な値です。書き込まれるリソースの順序についてクライアントとサーバーの間で確実に同意するために使用できます。
createTime

string (Timestamp format)

出力専用。リソース作成時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。リソース最終更新時のタイムスタンプ。ユーザーがリソースを変更した場合は、この値を更新する必要があります。サービスがリソースを変更した場合は、この値を更新する必要があります。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
deleteTime

string (Timestamp format)

出力専用。リソースが削除対象としてマークされたときのタイムスタンプ（削除は非同期オペレーションです）。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

RolloutState

ロールアウトの現在の状態。

列挙型
ROLLOUT_STATE_UNSPECIFIED 未指定の状態
ROLLOUT_STATE_RUNNING 現在、提供の準備を進めております。
ROLLOUT_STATE_PAUSED ロールアウトは一時停止されています。
ROLLOUT_STATE_SUCCEEDED ロールアウトが正常に完了しました。
ROLLOUT_STATE_FAILED ロールアウトが失敗しました。
ROLLOUT_STATE_CANCELLED 公開はキャンセルされました。
ROLLOUT_STATE_WAITING ロールアウトは、開始前に特定の条件が満たされるのを待っています。
ROLLOUT_STATE_CANCELLING ロールアウトをキャンセルしています。
ROLLOUT_STATE_RESUMING ロールアウトを再開しています。
ROLLOUT_STATE_PAUSING ロールアウトは一時停止中です。

RolloutStats

RolloutStats には、ロールアウトの進行状況に関する情報が含まれます。

JSON 表現 
{
  "operationsByState": [
    {
      object (Aggregate)
    }
  ]
}
フィールド
operationsByState[]

object (Aggregate)

省略可。出力専用。順序なしリスト。ロールアウトによってトリガーされたオペレーションの進行状況の内訳。オペレーションの数を状態別に示します。これは、更新されたユニットの数、または更新が予定されているユニットの数を特定するために使用できます。

グループごとにエントリは 1 つまでです。オペレーショングループの有効な値は、「SCHEDULED」、「PENDING」、「RUNNING」、「SUCCEEDED」、「FAILED」、「CANCELLED」です。

集計

特定のグループによる類似レコードの母集団の集合を表します。たとえば、ユニット数のコレクションを集計して、状態別にグループ化できます。

JSON 表現 
{
  "group": string,
  "count": integer
}
フィールド
group

string

必須。集計するグループ。
count

integer

必須。グループ内のレコード数。

RolloutControl

RolloutControl は、Rollout の実行を一時停止またはキャンセルして、Rollout の実行の変更をリクエストする方法を提供します。

JSON 表現 
{
  "action": enum (RolloutAction),

  // Union field action_params can be only one of the following:
  "runParams": {
    object (RunRolloutActionParams)
  }
  // End of list of possible types for union field action_params.
}
フィールド
action

enum (RolloutAction)

必須。ロールアウトで実行するアクション。デフォルトの動作では、ロールアウトは自然に終了状態になるまで実行されます。
共用体フィールド action_params。アクションの設定。設定はアクションと一致する必要があります。たとえば、action=RUN の場合は、run_params のみを設定するか、すべてのパラメータを省略できます。アクションに適用できない設定を行うとエラーになります。action_params は次のいずれかになります。
runParams

object (RunRolloutActionParams)

省略可。RUN アクションのパラメータ。RolloutAction が RUN に設定されていない場合にこれを指定すると、エラーになります。デフォルトでは、ロールアウトが再開されると、失敗したオペレーションが再試行されます。

RunRolloutActionParams

PAUSED 状態から再開されたときのロールアウトの動作を制御する RUN アクションのパラメータ。

JSON 表現 
{
  "retryFailedOperations": boolean
}
フィールド
retryFailedOperations

boolean

必須。true の場合、ロールアウトは再開時に失敗したオペレーションを再試行します。これは、ロールアウトの現在の状態が PAUSED で、リクエストされたアクションが RUN の場合にのみ適用されます。

RolloutAction

RolloutAction は、Rollout で実行するアクションを示します。

列挙型
ROLLOUT_ACTION_UNSPECIFIED アクションが指定されていません。デフォルトでは RUN として扱われます。
ROLLOUT_ACTION_RUN ロールアウトが自然に終了状態になるまで実行します。実行がリクエストされたロールアウトは、すべての自然なロールアウト状態（RUNNING -> SUCCEEDED や RUNNING -> FAILED など）を通過します。ロールアウト中に再試行可能なエラーが発生した場合、ロールアウトはデフォルトで一時停止されます。この RUN アクションを再リクエストすることで再開できます。
ROLLOUT_ACTION_PAUSE 再開（RUN がリクエストされる）まで、ロールアウトを一時停止します。
ROLLOUT_ACTION_CANCEL ロールアウトを完全にキャンセルします。

メソッド

create

 新しいロールアウトを作成します。

delete

 単一のロールアウトを削除します。

get

 単一のロールアウトを取得します。

list

 ロールアウトのコレクションを取得します。

patch

 単一のロールアウトを更新します。