Types

Para ver uma lista de métodos desse recurso, consulte o fim desta página.

Representações de recursos

Um tipo de recurso compatível com o 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
    }
  ]
}
Nome da propriedade Valor Descrição Observações
base nested object O tipo de base (serviço configurável) que oferece suporte a esse tipo.
base.collectionOverrides[] list Permite substituições de processamento de recursos para coleções específicas
base.collectionOverrides[].collection string A coleção que identifica esse recurso no serviço.
base.collectionOverrides[].options nested object As opções a serem aplicadas a essa substituição no nível do recurso
base.collectionOverrides[].options.asyncOptions[] list Opções sobre como encadear solicitações assíncronas.
base.collectionOverrides[].options.asyncOptions[].methodMatch string Expressão regular do método em que essa política será aplicada.
base.collectionOverrides[].options.asyncOptions[].pollingOptions nested object O Deployment Manager vai consultar instâncias para esse recurso da API, definindo um estado EXECUÇÃO e bloqueando até que as condições de pesquisa indiquem se o recurso foi concluído ou falhou.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[] list Uma matriz de diagnósticos a serem coletados pelo Deployment Manager. Esses diagnósticos serão exibidos ao usuário.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].field string Expressão JsonPath no recurso que, se não estiver vazia, indica que esse campo precisa ser extraído como um diagnóstico.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].level string Nível para registrar esse diagnóstico.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.failCondition string Expressão JsonPath que determina se a solicitação falhou.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.finishCondition string Expressão JsonPath que determina se a solicitação foi concluída.
base.collectionOverrides[].options.inputMappings[] list Os mapeamentos que se aplicam às solicitações.
base.collectionOverrides[].options.inputMappings[].fieldName string O nome do campo que será injetado.
base.collectionOverrides[].options.inputMappings[].location string O local em que esse mapeamento é aplicado.
base.collectionOverrides[].options.inputMappings[].methodMatch string Expressão regular para avaliar o método e decidir se a entrada é válida.
base.collectionOverrides[].options.inputMappings[].value string Uma expressão jsonPath para selecionar um elemento.
base.collectionOverrides[].options.validationOptions nested object Opções para validar e processar propriedades em um recurso.
base.collectionOverrides[].options.validationOptions.schemaValidation string Personalize como o Deployment Manager vai validar o recurso em relação a erros de esquema.
base.collectionOverrides[].options.validationOptions.undeclaredProperties string Especifique o que fazer com propriedades extras ao executar uma solicitação.
base.collectionOverrides[].options.virtualProperties string O bloco de propriedades adicionais é descrito como um jsonSchema. Essas propriedades nunca fazem parte do payload JSON, mas podem ser consumidas por InputMappings. Ele precisa ser um esquema JSON válido draft-04. As propriedades especificadas aqui serão separadas em uma seção diferente. Esse esquema será mesclado à validação do esquema, e as propriedades aqui serão extraídas do payload e consumidas explicitamente por InputMappings. Por exemplo: field1: type: string field2: type: number
base.credential nested object Credencial usada ao interagir com esse tipo.
base.credential.basicAuth nested object Credencial de autenticação básica, usada apenas pelo TypeProvider.
base.credential.basicAuth.password string
base.credential.basicAuth.user string
base.credential.serviceAccount nested object Credencial da conta de serviço, usada apenas pela implantação.
base.credential.serviceAccount.email string O endereço de e-mail da conta de serviço do IAM, como test@myproject.iam.gserviceaccount.com
base.credential.useProjectDefault boolean Especifique para usar a credencial padrão do projeto, com suporte apenas pela implantação.
base.descriptorUrl string Url do descritor para esse tipo.
base.options nested object Opções a serem aplicadas ao lidar com recursos neste serviço.
base.options.asyncOptions[] list Opções sobre como encadear solicitações assíncronas.
base.options.asyncOptions[].methodMatch string Expressão regular do método em que essa política será aplicada.
base.options.asyncOptions[].pollingOptions nested object O Deployment Manager vai consultar instâncias para esse recurso da API, definindo um estado EXECUÇÃO e bloqueando até que as condições de pesquisa indiquem se o recurso foi concluído ou falhou.
base.options.asyncOptions[].pollingOptions.diagnostics[] list Uma matriz de diagnósticos a serem coletados pelo Deployment Manager. Esses diagnósticos serão exibidos ao usuário.
base.options.asyncOptions[].pollingOptions.diagnostics[].field string Expressão JsonPath no recurso que, se não estiver vazia, indica que esse campo precisa ser extraído como um diagnóstico.
base.options.asyncOptions[].pollingOptions.diagnostics[].level string Nível para registrar esse diagnóstico.
base.options.asyncOptions[].pollingOptions.failCondition string Expressão JsonPath que determina se a solicitação falhou.
base.options.asyncOptions[].pollingOptions.finishCondition string Expressão JsonPath que determina se a solicitação foi concluída.
base.options.inputMappings[] list Os mapeamentos que se aplicam às solicitações.
base.options.inputMappings[].fieldName string O nome do campo que será injetado.
base.options.inputMappings[].location string O local em que esse mapeamento é aplicado.
base.options.inputMappings[].methodMatch string Expressão regular para avaliar o método e decidir se a entrada é válida.
base.options.inputMappings[].value string Uma expressão jsonPath para selecionar um elemento.
base.options.validationOptions nested object Opções para validar e processar propriedades em um recurso.
base.options.validationOptions.schemaValidation string Personalize como o Deployment Manager vai validar o recurso em relação a erros de esquema.
base.options.validationOptions.undeclaredProperties string Especifique o que fazer com propriedades extras ao executar uma solicitação.
base.options.virtualProperties string O bloco de propriedades adicionais descrito como um jsonSchema nunca faz parte do payload JSON, mas pode ser consumido por InputMappings. Ele precisa ser um esquema JSON válido draft-04. As propriedades especificadas aqui serão separadas em uma seção diferente. Esse esquema será mesclado à validação do esquema, e as propriedades aqui serão extraídas do payload e consumidas explicitamente por InputMappings. Por exemplo: field1: type: string field2: type: number
description string Descrição textual opcional do recurso, fornecida pelo cliente quando o recurso é criado.
id unsigned long
insertTime string Apenas saída. Carimbo de data/hora da criação no formato de texto RFC3339.
labels[] list Mapa de rótulos; fornecido pelo cliente quando o recurso é criado ou atualizado. Especificamente: as chaves de rótulo precisam ter entre 1 e 63 caracteres e estar em conformidade com a seguinte expressão regular: `[a-z]([-a-z0-9]*[a-z0-9])?`. Os valores de rótulo precisam ter entre 0 e 63 caracteres e estar em conformidade com a expressão regular `([a-z]([-a-z0-9]*[a-z0-9])?`)?`.

labels[].key string
labels[].value string
name string Nome do tipo.
operation nested object Apenas saída. A operação executada mais recentemente ou que está sendo executada nesse tipo.

Métodos

list
Lista todos os tipos de recursos do Deployment Manager.