Types

如需了解此资源的方法列表,请参阅本页结尾部分。

资源表示法

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 部署管理器将轮询此 API 资源的实例,并将状态设置为 RUNNING,并在轮询条件表明资源是已完成还是已失败之前进行阻塞。
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.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 服务账号凭据,仅供部署使用。
base.credential.serviceAccount.email string IAM 服务账号电子邮件地址,例如 test@myproject.iam.gserviceaccount.com
base.credential.useProjectDefault boolean 指定使用项目默认凭据,仅限部署支持。
base.descriptorUrl string 此类型的描述符网址。
base.options nested object 处理此服务中的任何资源时要应用的选项。
base.options.asyncOptions[] list 有关如何将异步请求串行处理的选项。
base.options.asyncOptions[].methodMatch string 此政策适用的方法正则表达式。
base.options.asyncOptions[].pollingOptions nested object 部署管理器将轮询此 API 资源的实例,并将状态设置为 RUNNING,并在轮询条件表明资源是已完成还是已失败之前进行阻塞。
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.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 仅限输出。对此类型最近运行或正在运行的操作。

方法

list
列出 Deployment Manager 的所有资源类型。