TypeProviders

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

リソースの表記

サービスに基づいたタイプを記述するタイプ プロバイダ。

{
  "id": unsigned long,
  "selfLink": string,
  "insertTime": string,
  "name": string,
  "description": string,
  "operation": operations Resource,
  "labels": [
    {
      "key": string,
      "value": string
    }
  ],
  "descriptorUrl": string,
  "credential": {
    "basicAuth": {
      "user": string,
      "password": string
    }
  },
  "options": {
    "inputMappings": [
      {
        "fieldName": string,
        "methodMatch": string,
        "value": string,
        "location": string
      }
    ],
    "validationOptions": {
      "undeclaredProperties": string,
      "schemaValidation": string
    },
    "virtualProperties": string
  },
  "collectionOverrides": [
    {
      "collection": string,
      "options": {
        "inputMappings": [
          {
            "fieldName": string,
            "methodMatch": string,
            "value": string,
            "location": string
          }
        ],
        "validationOptions": {
          "undeclaredProperties": string,
          "schemaValidation": string
        },
        "virtualProperties": string
      }
    }
  ]
}
プロパティ名 説明 備考
collectionOverrides[] list 特定のコレクションにリソース処理のオーバーライドを許可します。
collectionOverrides[].collection string このリソースをそのサービス内で識別するコレクション。
collectionOverrides[].options nested object このリソースレベルのオーバーライドに適用するオプション。
collectionOverrides[].options.inputMappings[] list リクエストの入力マッピング。
collectionOverrides[].options.inputMappings[].fieldName string この入力マッピングが適用されるフィールドの名前(fingerprint など)。
collectionOverrides[].options.inputMappings[].location string このマッピングが適用されるロケーション。
collectionOverrides[].options.inputMappings[].methodMatch string この入力マッピングが適用される 1 つ以上の API メソッド。正規表現を使用して適用されるメソッドを評価できます('methodMatch': '^(get|delete|put)$' など)。
collectionOverrides[].options.inputMappings[].value string このフィールドの値として要素を選択する JSON パス式。たとえば、fingerprint フィールドの値がリソースの fingerprint プロパティで見つかるように入力マッピングを作成していた場合、値の式は次のようになります。

$.resource.self.fingerprint
ユーザーの Deployment Manager 設定によって指定されるプロパティを選択する場合は、次のプロパティを使用できます。

$.resources.properties.name
詳細については。入力マッピングの指定をご覧ください。
collectionOverrides[].options.validationOptions nested object リソースのプロパティを検証する方法のオプションを設定します。
collectionOverrides[].options.validationOptions.schemaValidation string Deployment Manager がスキーマエラーに対してリソースを検証する方法をカスタマイズします。
collectionOverrides[].options.validationOptions.undeclaredProperties string リクエストを実行するときに、追加のプロパティをどのように処理するかを指定します。
collectionOverrides[].options.virtualProperties string JSON スキーマで記述された仮想プロパティを作成します。これらの仮想プロパティは API ペイロードの一部になることはありませんが、入力マッピングで消費されます。これは JSON スキーマ ドラフト 04 である必要があります。

このスキーマはスキーマ検証にマージされ、ここでのプロパティはペイロードから抽出されて、入力マッピングによって明示的に消費されます。例:

"virtualProperties": "schema: http://json-schema.org/draft-04/schema#\ntype: object\nproperties:\n  [PROPERTY]:\n    type: [DATA_TYPE]\n  [ANOTHER_PROPERTY]:\n    type: [ANOTHER_DATA_TYPE]n"
credential nested object このタイプを操作するときに使用する認証情報。
credential.basicAuth nested object この TypeProvider 用の基本認証情報。
credential.basicAuth.password string
credential.basicAuth.user string
description string リソースの作成時にクライアントにより表示されるリソースの説明文(省略可)。
descriptorUrl string このタイプ プロバイダ用の記述子 URL。
id unsigned long [出力専用] リソースの一意の識別子(サーバーが設定)。
insertTime string [出力専用] タイプ プロバイダの作成日時を示すタイムスタンプ(RFC3339 テキスト形式)。
labels[] list リソースの作成または更新時にクライアントが指定するラベルのマップ。注: ラベルキーの長さは 1~63 文字で、[a-z]([-a-z0-9]*[a-z0-9])? の正規表現に準拠する必要があります。Label の値は 0~63 文字の長さで、([a-z]([-a-z0-9]*[a-z0-9])?)? の正規表現に準拠する必要があります。
labels[].key string このラベルのキー。
labels[].value string このラベルの値。
name string タイプ プロバイダの名前。
operation nested object [出力専用] このタイプで最後に実行されたオペレーションまたは現在実行中のオペレーション。
options nested object このサービスでリソースを処理するときに適用するオプション。
options.inputMappings[] list リクエストの入力マッピング。
options.inputMappings[].fieldName string この入力マッピングが適用されるフィールドの名前(fingerprint など)。
options.inputMappings[].location string このマッピングが適用されるロケーション。
options.inputMappings[].methodMatch string この入力マッピングが適用される 1 つ以上の API メソッド。正規表現を使用して適用されるメソッドを評価できます('methodMatch': '^(get|delete|put)$' など)。
options.inputMappings[].value string このフィールドの値として要素を選択する JSON パス式。たとえば、fingerprint フィールドの値がリソースの fingerprint プロパティで見つかるように入力マッピングを作成していた場合、値の式は次のようになります。

$.resource.self.fingerprint
ユーザーの Deployment Manager 設定によって指定されるプロパティを選択する場合は、次のプロパティを使用できます。

$.resources.properties.name
詳細については。入力マッピングの指定をご覧ください。
options.validationOptions nested object リソースのプロパティを検証する方法のオプションを設定します。
options.validationOptions.schemaValidation string Deployment Manager がスキーマエラーに対してリソースを検証する方法をカスタマイズします。
options.validationOptions.undeclaredProperties string リクエストを実行するときに、追加のプロパティをどのように処理するかを指定します。
options.virtualProperties string JSON スキーマで記述された仮想プロパティを作成します。これらの仮想プロパティは API ペイロードの一部になることはありませんが、入力マッピングで消費されます。これは JSON スキーマ ドラフト 04 である必要があります。

このスキーマはスキーマ検証にマージされ、ここでのプロパティはペイロードから抽出されて、入力マッピングによって明示的に消費されます。例:

"virtualProperties": "schema: http://json-schema.org/draft-04/schema#\ntype: object\nproperties:\n  [PROPERTY]:\n    type: [DATA_TYPE]\n  [ANOTHER_PROPERTY]:\n    type: [ANOTHER_DATA_TYPE]n"

メソッド

delete
タイプ プロバイダを削除します。
get
特定のタイプ プロバイダに関する情報を取得します。
getType
タイプ プロバイダが指定するタイプの情報を取得します。
insert
タイプ プロバイダを作成します。
list
Deployment Manager のすべてのリソースタイプ プロバイダに関する一覧を取得します。
listTypes
TypeProvider のすべてのタイプ情報を一覧表示します。
patch
タイプ プロバイダを更新します。このメソッドは、パッチのセマンティクスをサポートしています。
update
タイプ プロバイダを更新します。
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...