このリソースのメソッドのリストについては、このページの末尾をご覧ください。
リソースの表記
Deployment Manager でサポートされているリソースタイプ。
{ "name":string , "base": { "descriptorUrl":string , "credential": { "basicAuth": { "user":string , "password":string }, "serviceAccount": { "email":string }, "useProjectDefault":boolean }, "options": { "inputMappings": [ { "fieldName":string , "methodMatch":string , "value":string , "location":string } ], "validationOptions": { "undeclaredProperties":string , "schemaValidation":string }, "virtualProperties":string , "asyncOptions": [ { "methodMatch":string , "pollingOptions": { "finishCondition":string , "failCondition":string , "targetLink":string , "pollingLink":string , "diagnostics": [ { "field":string , "level":string } ] } } ] }, "collectionOverrides": [ { "collection":string , "options": { "inputMappings": [ { "fieldName":string , "methodMatch":string , "value":string , "location":string } ], "validationOptions": { "undeclaredProperties":string , "schemaValidation":string }, "virtualProperties":string , "asyncOptions": [ { "methodMatch":string , "pollingOptions": { "finishCondition":string , "failCondition":string , "targetLink":string , "pollingLink":string , "diagnostics": [ { "field":string , "level":string } ] } } ] } } ] }, "id":unsigned long , "insertTime":string , "description":string , "selfLink":string , "operation": operations Resource, "labels": [ { "key":string , "value":string } ] }
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
base |
nested object |
このタイプをサポートする基本タイプ(構成可能なサービス)。 | |
base.collectionOverrides[] |
list |
特定のコレクションにリソース処理のオーバーライドを許可します。 | |
base.collectionOverrides[].collection |
string |
このリソースをそのサービス内で識別するコレクション。 | |
base.collectionOverrides[].options |
nested object |
このリソースレベルのオーバーライドに適用するオプション | |
base.collectionOverrides[].options.asyncOptions[] |
list |
非同期リクエストのスレッド化方法に関するオプション。 | |
base.collectionOverrides[].options.asyncOptions[].methodMatch |
string |
このポリシーが適用されるメソッドの正規表現。 | |
base.collectionOverrides[].options.asyncOptions[].pollingOptions |
nested object |
Deployment Manager は、RUNNING 状態を設定したこの API リソースのインスタンスをポーリングし、ポーリング条件がリソースが完了したか失敗したかを通知するまでブロックします。 | |
base.collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[] |
list |
Deployment Manager によって収集される診断情報の配列。これらの診断情報はユーザーに表示されます。 | |
base.collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].field |
string |
リソースの JsonPath 式。空でない場合、このフィールドを診断として抽出する必要があることを示します。 | |
base.collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].level |
string |
この診断を記録するレベル。 | |
base.collectionOverrides[].options.asyncOptions[].pollingOptions.failCondition |
string |
リクエストが失敗したかどうかを判断する JsonPath 式。 | |
base.collectionOverrides[].options.asyncOptions[].pollingOptions.finishCondition |
string |
リクエストが完了したかどうかを判断する JsonPath 式。 | |
base.collectionOverrides[].options.asyncOptions[].pollingOptions.pollingLink |
string |
文字列に評価される JSONPath 式。ポーリングする場所を示します。 | |
base.collectionOverrides[].options.asyncOptions[].pollingOptions.targetLink |
string |
ポーリングが完了した後、JsonPath 式はリソースを取得する場所を示します。 | |
base.collectionOverrides[].options.inputMappings[] |
list |
リクエストに適用されるマッピング。 | |
base.collectionOverrides[].options.inputMappings[].fieldName |
string |
挿入するフィールドの名前。 | |
base.collectionOverrides[].options.inputMappings[].location |
string |
このマッピングが適用されるロケーション。 | |
base.collectionOverrides[].options.inputMappings[].methodMatch |
string |
入力が適用されるかどうかを判断するメソッドで評価する正規表現。 | |
base.collectionOverrides[].options.inputMappings[].value |
string |
要素を選択する JSONPath 式。 | |
base.collectionOverrides[].options.validationOptions |
nested object |
リソースのプロパティを検証して処理する方法のオプション。 | |
base.collectionOverrides[].options.validationOptions.schemaValidation |
string |
Deployment Manager がスキーマエラーに対してリソースを検証する方法をカスタマイズします。 | |
base.collectionOverrides[].options.validationOptions.undeclaredProperties |
string |
リクエストを実行するときに、追加のプロパティをどのように処理するかを指定します。 | |
base.collectionOverrides[].options.virtualProperties |
string |
jsonSchema として記述された追加プロパティ ブロック。これらのプロパティは JSON ペイロードの一部になることはありませんが、InputMappings で使用できます。これは有効な JSON スキーマのドラフト 04 である必要があります。ここで指定したプロパティは、別のセクションで分離されます。このスキーマはスキーマ検証に統合され、ここでのプロパティはペイロードから抽出され、InputMappings によって明示的に使用されます。例: field1: type: string field2: type: number | |
base.credential |
nested object |
このタイプを操作するときに使用する認証情報。 | |
base.credential.basicAuth |
nested object |
基本認証の認証情報。TypeProvider でのみ使用されます。 | |
base.credential.basicAuth.password |
string |
||
base.credential.basicAuth.user |
string |
||
base.credential.serviceAccount |
nested object |
サービス アカウント認証情報。Deployment でのみ使用されます。 | |
base.credential.serviceAccount.email |
string |
IAM サービス アカウントのメールアドレス(test@myproject.iam.gserviceaccount.com など) | |
base.credential.useProjectDefault |
boolean |
Deployment でのみサポートされるプロジェクトのデフォルト認証情報を使用するように指定します。 | |
base.descriptorUrl |
string |
このタイプの記述子の URL。 | |
base.options |
nested object |
このサービスでリソースを処理するときに適用するオプション。 | |
base.options.asyncOptions[] |
list |
非同期リクエストのスレッド化方法に関するオプション。 | |
base.options.asyncOptions[].methodMatch |
string |
このポリシーが適用されるメソッドの正規表現。 | |
base.options.asyncOptions[].pollingOptions |
nested object |
Deployment Manager は、RUNNING 状態を設定したこの API リソースのインスタンスをポーリングし、ポーリング条件がリソースが完了したか失敗したかを通知するまでブロックします。 | |
base.options.asyncOptions[].pollingOptions.diagnostics[] |
list |
Deployment Manager によって収集される診断情報の配列。これらの診断情報はユーザーに表示されます。 | |
base.options.asyncOptions[].pollingOptions.diagnostics[].field |
string |
リソースの JsonPath 式。空でない場合、このフィールドを診断として抽出する必要があることを示します。 | |
base.options.asyncOptions[].pollingOptions.diagnostics[].level |
string |
この診断を記録するレベル。 | |
base.options.asyncOptions[].pollingOptions.failCondition |
string |
リクエストが失敗したかどうかを判断する JsonPath 式。 | |
base.options.asyncOptions[].pollingOptions.finishCondition |
string |
リクエストが完了したかどうかを判断する JsonPath 式。 | |
base.options.asyncOptions[].pollingOptions.pollingLink |
string |
文字列に評価される JSONPath 式。ポーリングする場所を示します。 | |
base.options.asyncOptions[].pollingOptions.targetLink |
string |
ポーリングが完了した後、JsonPath 式はリソースを取得する場所を示します。 | |
base.options.inputMappings[] |
list |
リクエストに適用されるマッピング。 | |
base.options.inputMappings[].fieldName |
string |
挿入するフィールドの名前。 | |
base.options.inputMappings[].location |
string |
このマッピングが適用されるロケーション。 | |
base.options.inputMappings[].methodMatch |
string |
入力が適用されるかどうかを判断するメソッドで評価する正規表現。 | |
base.options.inputMappings[].value |
string |
要素を選択する JSONPath 式。 | |
base.options.validationOptions |
nested object |
リソースのプロパティを検証して処理する方法のオプション。 | |
base.options.validationOptions.schemaValidation |
string |
Deployment Manager がスキーマエラーに対してリソースを検証する方法をカスタマイズします。 | |
base.options.validationOptions.undeclaredProperties |
string |
リクエストを実行するときに、追加のプロパティをどのように処理するかを指定します。 | |
base.options.virtualProperties |
string |
jsonSchema として記述された追加プロパティ ブロック。これらのプロパティは JSON ペイロードの一部になることはありませんが、InputMappings で使用できます。これは有効な JSON スキーマのドラフト 04 である必要があります。ここで指定したプロパティは、別のセクションで分離されます。このスキーマはスキーマ検証に統合され、ここでのプロパティはペイロードから抽出され、InputMappings によって明示的に使用されます。例: field1: type: string field2: type: number | |
description |
string |
リソースの作成時にクライアントにより表示されるリソースの説明文(省略可)。 | |
id |
unsigned long |
||
insertTime |
string |
出力専用。作成タイムスタンプ(RFC3339 テキスト形式)。 | |
labels[] |
list |
リソースの作成または更新時にクライアントが指定するラベルのマップ。具体的には、ラベルキーの長さは 1 ~ 63 文字で、正規表現 `[a-z]([-a-z0-9]*[a-z0-9])?` に準拠する必要があります。ラベル値の長さは 0 ~ 63 文字で、正規表現 `([a-z]([-a-z0-9]*[a-z0-9])?)?` に準拠する必要があります。 |
|
labels[].key |
string |
||
labels[].value |
string |
||
name |
string |
タイプの名前。 | |
operation |
nested object |
出力専用。このタイプで最後に実行されたオペレーション、または現在実行中のオペレーション。 | |
selfLink |
string |
出力専用。リソースのサーバー定義 URL。 |
メソッド
- list
- Deployment Manager のすべてのリソースタイプを一覧表示します。