TypeProviders

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

リソースの表記

サービス バックの型を記述するタイプ プロバイダ。

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

メソッド

delete
タイプ プロバイダを削除します。
get
特定のタイプ プロバイダに関する情報を取得します。
getType
TypeProvider によって提供される型の型情報を取得します。
insert
タイプ プロバイダを作成します。
list
Deployment Manager のすべてのリソースタイプ プロバイダを一覧表示します。
listTypes
TypeProvider のすべての型情報を一覧表示します。
patch
タイプ プロバイダにパッチを適用します。
update
タイプ プロバイダを更新します。