Deployments

デプロイは、設定ファイルを使用して、まとめてデプロイ、管理されるリソースの集合です。

このリソースのメソッドのリストについては、このページの末尾をご覧ください。

リソースの表記



{
  "id": unsigned long,
  "name": string,
  "description": string,
  "operation": operations Resource,
  "fingerprint": bytes,
  "manifest": string,
  "update": {
    "manifest": string,
    "labels": [
      {
        "key": string,
        "value": string
      }
    ],
    "description": string
  },
  "insertTime": string,
  "updateTime": string,
  "target": {
    "config": {
      "content": string
    },
    "imports": [
      {
        "name": string,
        "content": string
      }
    ]
  },
  "labels": [
    {
      "key": string,
      "value": string
    }
  ],
  "selfLink": string
}
プロパティ名 説明 メモ
description string ユーザーによるデプロイの説明。省略可。
fingerprint bytes update()stop()cancelPreview() リクエストなど、デプロイメントを変更するリクエストで使用するフィンガープリントを指定します。フィンガープリントはランダムに生成される値で、オプティミスティック ロックを実行するには update()stop()cancelPreview() リクエストで指定する必要があります。これにより、楽観的並行性制御を行い、同時に発生するリクエストを 1 つだけに限定することができます。

フィンガープリントは最初に Deployment Manager によって生成され、データの変更リクエストごとに変更されます。最新のフィンガープリント値を取得するには、デプロイメントに対して get() リクエストを実行します。
id unsigned long 出力専用。デプロイメントの一意の識別子。
insertTime string 出力専用。作成タイムスタンプ(RFC3339 テキスト形式)。
labels[] list リソースの作成または更新時にクライアントが指定するラベルのマップ。具体的には、ラベルキーの長さは 1 ~ 63 文字で、[a-z][-_a-z0-9]* という正規表現に準拠する必要があります。ラベル値は 0 ~ 63 文字で、正規表現 [-_a-z0-9]* に準拠している必要があります。
labels[].key string
labels[].value string
manifest string 出力専用。正常にデプロイされた最後のマニフェストを表すマニフェストの URL。
name string リソースの作成時にクライアントが指定するリソースの名前。名前は 1 ~ 63 文字で、RFC1035 に準拠している必要があります。具体的には、名前は 1 ~ 63 文字で、正規表現 [a-z]([-a-z0-9]*[a-z0-9])? と一致している必要があります。つまり、先頭文字には小文字を使用し、残りの文字にはダッシュ、小文字、数字を使用する必要があります。ただし最後の文字にはダッシュを使用できません。
operation nested object 出力専用。このデプロイで最近実行された、または現在実行中のオペレーション。
target nested object [入力専用] デプロイを定義するパラメータ。デプロイの設定とそれに関連するテンプレートが含まれます。
target.config nested object このデプロイに使用するルート構成ファイル。
target.config.content string 構成ファイルの YAML の内容全体。
target.imports[] list この設定のためにインポートするすべてのファイル。テンプレートや他のファイルをインポートするために使用されます。たとえば、テキスト ファイルをインポートしてテンプレート内で使用する場合があります。
target.imports[].content string インポートするテンプレートの完全な内容。
target.imports[].name string YAML 構成で宣言されている、インポートするテンプレートの名前。
update nested object 出力専用。Deployment Manager が現在このデプロイの更新を実行中またはプレビュー中の場合、更新された構成がここに表示されます。
update.description string 出力専用。現在の更新が適用された後のデプロイメントの説明(省略可)。
update.labels[] list 出力専用。リソースの作成または更新時にクライアントが指定するラベルのマップ。具体的には、ラベルキーの長さは 1 ~ 63 文字で、[a-z][-_a-z0-9]* という正規表現に準拠する必要があります。ラベル値は 0 ~ 63 文字で、正規表現 [-_a-z0-9]* に準拠している必要があります。
update.labels[].key string
update.labels[].value string
update.manifest string 出力専用。このデプロイの更新構成を表すマニフェストの URL。
updateTime string 出力専用。更新タイムスタンプ(RFC3339 テキスト形式)。

メソッド

cancelPreview
デプロイに現在関連付けられているプレビューをキャンセルして削除します。
delete
デプロイとデプロイ内のすべてのリソースを削除します。
get
特定のデプロイに関する情報を取得します。
getIamPolicy
リソースのアクセス制御ポリシーを取得します。このようなポリシーまたはリソースが存在しない場合は空白になることがあります。
insert
デプロイメントと、Deployment マニフェストで記述されているすべてのリソースを作成します。
list
指定されたプロジェクトのすべてのデプロイメントを一覧表示します。
patch
デプロイメントと、デプロイ マニフェストで記述されているすべてのリソースにパッチを適用します。このメソッドはパッチのセマンティクスをサポートしています。
setIamPolicy
指定したリソースにアクセス制御ポリシーを設定します。既存のポリシーをすべて置き換えます。
stop
進行中のオペレーションを停止します。完了した作業内容をロールバックするわけではありませんが、作業内容の未実行部分が開始されなくなります。
testIamPermissions
指定したリソースに対して呼び出し元が持っている権限を返します。
update
デプロイメントと、デプロイ マニフェストで記述されているすべてのリソースを更新します。