TypeProviders

Para obtener una lista de los métodos de este recurso, consulta el final de esta página.

Representaciones de recursos

Un proveedor de tipos que describe un tipo respaldado por un servicio. 

{
  "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
  ]
}
Nombre de la propiedad Valor Descripción Notas
collectionOverrides[] list Permite anulaciones de manejo de recursos para colecciones específicas
collectionOverrides[].collection string Es la colección que identifica este recurso dentro de su servicio.
collectionOverrides[].options nested object Las opciones que se aplicarán a esta anulación a nivel del recurso
collectionOverrides[].options.asyncOptions[] list Opciones para subdividir solicitudes asíncronas.
collectionOverrides[].options.asyncOptions[].methodMatch string La regex del método en la que se aplicará esta política.
collectionOverrides[].options.asyncOptions[].pollingOptions nested object El Administrador de implementaciones sondeará las instancias de este recurso de API para establecer un estado RUNNING y bloqueará hasta que las condiciones de sondeo indiquen si el recurso se completó o falló.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[] list Es un array de diagnósticos que recopilará Deployment Manager. Estos diagnósticos se mostrarán al usuario.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].field string Es una expresión JsonPath en el recurso que, si no está vacía, indica que este campo se debe extraer como un diagnóstico.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].level string Es el nivel en el que se registra este diagnóstico.
collectionOverrides[].options.asyncOptions[].pollingOptions.failCondition string Es la expresión JSONPath que determina si la solicitud falló.
collectionOverrides[].options.asyncOptions[].pollingOptions.finishCondition string Es una expresión JSONPath que determina si se completó la solicitud.
collectionOverrides[].options.inputMappings[] list Las asignaciones que se aplican a las solicitudes.
collectionOverrides[].options.inputMappings[].fieldName string Es el nombre del campo que se insertará.
collectionOverrides[].options.inputMappings[].location string Es la ubicación a la que se aplica esta asignación.
collectionOverrides[].options.inputMappings[].methodMatch string Es la regex que se evalúa en el método para decidir si se aplica la entrada.
collectionOverrides[].options.inputMappings[].value string Es una expresión JSONPath para seleccionar un elemento.
collectionOverrides[].options.validationOptions nested object Son opciones para validar y procesar propiedades en un recurso.
collectionOverrides[].options.validationOptions.schemaValidation string Personaliza la forma en que Deployment Manager validará el recurso en función de los errores de esquema.
collectionOverrides[].options.validationOptions.undeclaredProperties string Especifica qué hacer con las propiedades adicionales cuando se ejecuta una solicitud.
collectionOverrides[].options.virtualProperties string Bloque de propiedades adicionales descrito como un jsonSchema. Estas propiedades nunca serán parte de la carga útil de JSON, pero InputMappings puede consumirlas. Debe ser un esquema de JSON válido de la versión borrador 04. Las propiedades especificadas aquí se desacoplarán en una sección diferente. Este esquema se combinará con la validación del esquema, y las propiedades aquí se extraerán de la carga útil y se consumirán de forma explícita por InputMappings. p. ej., field1: type: string field2: type: number
credential nested object Credencial que se usa cuando se interactúa con este tipo.
credential.basicAuth nested object Credencial de autenticación básica que solo usa TypeProvider.
credential.basicAuth.password string
credential.basicAuth.user string
credential.serviceAccount nested object Credencial de la cuenta de servicio, que solo usa la implementación.
credential.serviceAccount.email string La dirección de correo electrónico de la cuenta de servicio de IAM, como prueba@miproyecto.iam.gserviceaccount.com
credential.useProjectDefault boolean Especifica que se usará la credencial predeterminada del proyecto, que solo es compatible con la implementación.
customCertificateAuthorityRoots[] list Es una lista de hasta 2 raíces de autoridades certificadoras personalizadas que se usarán para la autenticación de TLS cuando se realicen llamadas en nombre de este proveedor de tipos. Si se establece, la autenticación de TLS usará exclusivamente estas raíces en lugar de depender de autoridades certificadoras de confianza pública cuando valide la autenticidad del certificado TLS. Los certificados deben estar en formato PEM codificado en base64. El tamaño máximo de cada certificado no debe superar los 10 KB.
description string Es una descripción textual opcional del recurso que proporciona el cliente cuando se crea el recurso.
descriptorUrl string Es la URL del descriptor de este proveedor de tipos.
id unsigned long Solo salida. Es el identificador único del recurso que define el servidor.
insertTime string Solo salida. Marca de tiempo de creación en formato de texto RFC3339.
labels[] list Es un mapa de etiquetas que proporciona el cliente cuando se crea o actualiza el recurso. Específicamente, las claves de etiquetas deben tener entre 1 y 63 caracteres y deben cumplir con la siguiente expresión regular: `[a-z]([-a-z0-9]*[a-z0-9])?`. Los valores de las etiquetas deben tener entre 0 y 63 caracteres y deben cumplir con la expresión regular `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

labels[].key string
labels[].value string
name string Es el nombre del recurso que proporciona el cliente cuando lo crea. El nombre debe tener entre 1 y 63 caracteres y cumplir con RFC1035. Específicamente, el nombre debe tener entre 1 y 63 caracteres y coincidir con la expresión regular `[a-z]([-a-z0-9]*[a-z0-9])?`, lo que significa que el primer carácter debe ser una letra minúscula y los siguientes deben ser un guion, una letra minúscula o un dígito, excepto el último carácter, que no puede ser un guion.
operation nested object Solo salida. La operación que se ejecutó más recientemente o que se está ejecutando en este proveedor de tipos.
options nested object Son opciones que se aplican cuando se manejan recursos en este servicio.
options.asyncOptions[] list Opciones para subdividir solicitudes asíncronas.
options.asyncOptions[].methodMatch string La regex del método en la que se aplicará esta política.
options.asyncOptions[].pollingOptions nested object El Administrador de implementaciones sondeará las instancias de este recurso de API para establecer un estado RUNNING y bloqueará hasta que las condiciones de sondeo indiquen si el recurso se completó o falló.
options.asyncOptions[].pollingOptions.diagnostics[] list Es un array de diagnósticos que recopilará Deployment Manager. Estos diagnósticos se mostrarán al usuario.
options.asyncOptions[].pollingOptions.diagnostics[].field string Es una expresión JsonPath en el recurso que, si no está vacía, indica que este campo se debe extraer como un diagnóstico.
options.asyncOptions[].pollingOptions.diagnostics[].level string Es el nivel en el que se registra este diagnóstico.
options.asyncOptions[].pollingOptions.failCondition string Es la expresión JSONPath que determina si la solicitud falló.
options.asyncOptions[].pollingOptions.finishCondition string Es una expresión JSONPath que determina si se completó la solicitud.
options.inputMappings[] list Las asignaciones que se aplican a las solicitudes.
options.inputMappings[].fieldName string Es el nombre del campo que se insertará.
options.inputMappings[].location string Es la ubicación a la que se aplica esta asignación.
options.inputMappings[].methodMatch string Es la regex que se evalúa en el método para decidir si se aplica la entrada.
options.inputMappings[].value string Es una expresión JSONPath para seleccionar un elemento.
options.validationOptions nested object Son opciones para validar y procesar propiedades en un recurso.
options.validationOptions.schemaValidation string Personaliza la forma en que Deployment Manager validará el recurso en función de los errores de esquema.
options.validationOptions.undeclaredProperties string Especifica qué hacer con las propiedades adicionales cuando se ejecuta una solicitud.
options.virtualProperties string Bloque de propiedades adicionales descrito como un jsonSchema. Estas propiedades nunca serán parte de la carga útil de JSON, pero InputMappings puede consumirlas. Debe ser un esquema de JSON válido de la versión borrador 04. Las propiedades especificadas aquí se desacoplarán en una sección diferente. Este esquema se combinará con la validación del esquema, y las propiedades aquí se extraerán de la carga útil y se consumirán de forma explícita por InputMappings. p. ej., field1: type: string field2: type: number

Métodos

borrar
Borra un proveedor de tipos.
get
Obtiene información sobre un proveedor de tipos específico.
getType
Obtiene información de tipo para un tipo proporcionado por un TypeProvider.
insertar
Crea un proveedor de tipos.
lista
Enumera todos los proveedores de tipos de recursos para Deployment Manager.
listTypes
Enumera toda la información de tipo de un TypeProvider.
patch
Parchea un proveedor de tipos.
actualización
Actualiza un proveedor de tipos.