TypeProviders

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

Representações de recursos

Um provedor de tipos que descreve um tipo com suporte de serviço. 

{
  "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
  ]
}
Nome da propriedade Valor Descrição Observações
collectionOverrides[] list Permite substituições de processamento de recursos para coleções específicas
collectionOverrides[].collection string A coleção que identifica esse recurso no serviço.
collectionOverrides[].options nested object As opções a serem aplicadas a essa substituição no nível do recurso
collectionOverrides[].options.asyncOptions[] list Opções sobre como encadear solicitações assíncronas.
collectionOverrides[].options.asyncOptions[].methodMatch string Expressão regular do método em que essa política será aplicada.
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.
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.
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.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].level string Nível para registrar esse diagnóstico.
collectionOverrides[].options.asyncOptions[].pollingOptions.failCondition string Expressão JsonPath que determina se a solicitação falhou.
collectionOverrides[].options.asyncOptions[].pollingOptions.finishCondition string Expressão JsonPath que determina se a solicitação foi concluída.
collectionOverrides[].options.inputMappings[] list Os mapeamentos que se aplicam às solicitações.
collectionOverrides[].options.inputMappings[].fieldName string O nome do campo que será injetado.
collectionOverrides[].options.inputMappings[].location string O local em que esse mapeamento é aplicado.
collectionOverrides[].options.inputMappings[].methodMatch string Expressão regular para avaliar o método e decidir se a entrada é válida.
collectionOverrides[].options.inputMappings[].value string Uma expressão jsonPath para selecionar um elemento.
collectionOverrides[].options.validationOptions nested object Opções para validar e processar propriedades em um recurso.
collectionOverrides[].options.validationOptions.schemaValidation string Personalize como o Deployment Manager vai validar o recurso em relação a erros de esquema.
collectionOverrides[].options.validationOptions.undeclaredProperties string Especifique o que fazer com propriedades extras ao executar uma solicitação.
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
credential nested object Credencial usada ao interagir com esse tipo.
credential.basicAuth nested object Credencial de autenticação básica, usada apenas pelo TypeProvider.
credential.basicAuth.password string
credential.basicAuth.user string
credential.serviceAccount nested object Credencial da conta de serviço, usada apenas pela implantação.
credential.serviceAccount.email string O endereço de e-mail da conta de serviço do IAM, como test@myproject.iam.gserviceaccount.com
credential.useProjectDefault boolean Especifique para usar a credencial padrão do projeto, com suporte apenas pela implantação.
customCertificateAuthorityRoots[] list Lista de até duas autoridades certificadoras raiz personalizadas a serem usadas para autenticação TLS ao fazer chamadas em nome desse tipo de provedor. Se definido, a autenticação TLS vai usar exclusivamente essas raízes em vez de depender de autoridades de certificação confiáveis publicamente ao validar a autenticidade do certificado TLS. Os certificados precisam estar no formato PEM codificado em base64. O tamanho máximo de cada certificado não pode exceder 10 KB.
description string Descrição textual opcional do recurso, fornecida pelo cliente quando o recurso é criado.
descriptorUrl string Url do descritor para esse provedor de tipos.
id unsigned long Apenas saída. Identificador exclusivo do recurso definido pelo servidor.
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 recurso, fornecido pelo cliente quando o recurso é criado. O nome precisa ter de 1 a 63 caracteres e estar de acordo com o RFC1035. Especificamente, o nome precisa ter de 1 a 63 caracteres e corresponder à expressão regular `[a-z]([-a-z0-9]*[a-z0-9])?`, o que significa que o primeiro caractere precisa ser uma letra minúscula e todos os caracteres seguintes precisam ser um hífen, uma letra minúscula ou um dígito, exceto o último caractere, que não pode ser um hífen.
operation nested object Apenas saída. A operação executada mais recentemente ou que está sendo executada no provedor desse tipo.
options nested object Opções a serem aplicadas ao lidar com recursos neste serviço.
options.asyncOptions[] list Opções sobre como encadear solicitações assíncronas.
options.asyncOptions[].methodMatch string Expressão regular do método em que essa política será aplicada.
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.
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.
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.
options.asyncOptions[].pollingOptions.diagnostics[].level string Nível para registrar esse diagnóstico.
options.asyncOptions[].pollingOptions.failCondition string Expressão JsonPath que determina se a solicitação falhou.
options.asyncOptions[].pollingOptions.finishCondition string Expressão JsonPath que determina se a solicitação foi concluída.
options.inputMappings[] list Os mapeamentos que se aplicam às solicitações.
options.inputMappings[].fieldName string O nome do campo que será injetado.
options.inputMappings[].location string O local em que esse mapeamento é aplicado.
options.inputMappings[].methodMatch string Expressão regular para avaliar o método e decidir se a entrada é válida.
options.inputMappings[].value string Uma expressão jsonPath para selecionar um elemento.
options.validationOptions nested object Opções para validar e processar propriedades em um recurso.
options.validationOptions.schemaValidation string Personalize como o Deployment Manager vai validar o recurso em relação a erros de esquema.
options.validationOptions.undeclaredProperties string Especifique o que fazer com propriedades extras ao executar uma solicitação.
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

Métodos

delete
Exclui um provedor de tipos.
get
Recebe informações sobre um provedor de tipos específico.
getType
Recebe informações de tipo para um tipo fornecido por um TypeProvider.
inserir
Cria um provedor de tipos.
list
Lista todos os provedores de tipo de recurso do Deployment Manager.
listTypes
Lista todas as informações de tipo de um TypeProvider.
patch
Patches a um provedor de tipos.
atualizar
Atualiza um provedor de tipos.