TypeProviders

La liste des méthodes associées à cette ressource est présentée au bas de la page.

Représentations de la ressource

Fournisseur de types qui décrit un type compatible avec un service. 

{
  "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
  ]
}
Nom de propriété Valeur Description Remarques
collectionOverrides[] list Permet de remplacer la gestion des ressources pour des collections spécifiques
collectionOverrides[].collection string Collection qui identifie cette ressource dans son service.
collectionOverrides[].options nested object Options à appliquer à ce forçage au niveau de la ressource
collectionOverrides[].options.asyncOptions[] list Options concernant la création de threads pour les requêtes asynchrones.
collectionOverrides[].options.asyncOptions[].methodMatch string Expression régulière de la méthode à laquelle cette règle s'applique.
collectionOverrides[].options.asyncOptions[].pollingOptions nested object Deployment Manager interroge les instances de cette ressource d'API en définissant un état RUNNING et en bloquant jusqu'à ce que les conditions d'interrogation indiquent si la ressource est terminée ou a échoué.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[] list Tableau de diagnostics à collecter par Deployment Manager. Ces diagnostics seront affichés à l'utilisateur.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].field string Expression JsonPath sur la ressource qui, si elle n'est pas vide, indique que ce champ doit être extrait en tant que diagnostic.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].level string Niveau d'enregistrement de ce diagnostic.
collectionOverrides[].options.asyncOptions[].pollingOptions.failCondition string Expression JSONPath qui détermine si la requête a échoué.
collectionOverrides[].options.asyncOptions[].pollingOptions.finishCondition string Expression JSONPath qui détermine si la requête est terminée.
collectionOverrides[].options.inputMappings[] list Mappages qui s'appliquent aux requêtes.
collectionOverrides[].options.inputMappings[].fieldName string Nom du champ qui va être injecté.
collectionOverrides[].options.inputMappings[].location string Lieu auquel ce mappage s'applique.
collectionOverrides[].options.inputMappings[].methodMatch string Expression régulière à évaluer sur la méthode pour déterminer si l'entrée s'applique.
collectionOverrides[].options.inputMappings[].value string Expression JSONPath permettant de sélectionner un élément.
collectionOverrides[].options.validationOptions nested object Options permettant de valider et de traiter les propriétés d'une ressource.
collectionOverrides[].options.validationOptions.schemaValidation string Personnalisez la façon dont Deployment Manager valide la ressource par rapport aux erreurs de schéma.
collectionOverrides[].options.validationOptions.undeclaredProperties string Spécifiez ce qu'il faut faire avec les propriétés supplémentaires lors de l'exécution d'une requête.
collectionOverrides[].options.virtualProperties string Bloc de propriétés supplémentaires décrit comme un jsonSchema. Ces propriétés ne feront jamais partie de la charge utile JSON, mais elles peuvent être utilisées par InputMappings. Il doit s'agir d'un schéma JSON draft-04 valide. Les propriétés spécifiées ici seront dissociées dans une autre section. Ce schéma sera fusionné avec la validation du schéma, et les propriétés ici seront extraites de la charge utile et consommées explicitement par InputMappings. Exemple: field1: type: string field2: type: number
credential nested object Identifiants utilisés lors de l'interaction avec ce type.
credential.basicAuth nested object Identifiants d'authentification de base, utilisés uniquement par TypeProvider.
credential.basicAuth.password string
credential.basicAuth.user string
credential.serviceAccount nested object Identifiants du compte de service, utilisés uniquement par le déploiement.
credential.serviceAccount.email string L'adresse e-mail du compte de service IAM, par exemple test@monprojet.iam.gserviceaccount.com
credential.useProjectDefault boolean Spécifiez d'utiliser les identifiants par défaut du projet, qui ne sont acceptés que par le déploiement.
customCertificateAuthorityRoots[] list Liste de deux racines d'autorité de certification personnalisées à utiliser pour l'authentification TLS lors de l'établissement d'appels au nom de ce fournisseur de types. Si ce paramètre est défini, l'authentification TLS utilisera exclusivement ces racines au lieu de s'appuyer sur des autorités de certification publiques approuvées lors de la validation de l'authenticité des certificats TLS. Les certificats doivent être au format PEM encodé en base64. La taille maximale de chaque certificat ne doit pas dépasser 10 Ko.
description string Description textuelle facultative de la ressource qui est fournie par le client lors de la création de cette dernière.
descriptorUrl string URL du descripteur de ce fournisseur de types.
id unsigned long Uniquement en sortie. Identifiant unique de la ressource définie par le serveur.
insertTime string Uniquement en sortie. Code temporel de création au format texte RFC3339.
labels[] list Mappage des libellés, fourni par le client lors de la création ou de la mise à jour de la ressource. Plus précisément: les clés de libellé doivent comporter entre 1 et 63 caractères et respecter l'expression régulière suivante: `[a-z]([-a-z0-9]*[a-z0-9])?`. Les valeurs des libellés doivent comporter entre 0 et 63 caractères et respecter l'expression régulière `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

labels[].key string
labels[].value string
name string Nom de la ressource, fourni par le client lors de sa création. Le nom doit comporter entre 1 et 63 caractères, et être conforme à la norme RFC 1035. Plus précisément, le nom doit comporter entre 1 et 63 caractères et correspondre à l'expression régulière `[a-z]([-a-z0-9]*[a-z0-9])?`, ce qui signifie que le premier caractère doit être une lettre minuscule, et que tous les caractères suivants doivent être un tiret, une lettre minuscule ou un chiffre, à l'exception du dernier caractère, qui ne peut pas être un tiret.
operation nested object Uniquement en sortie. Opération exécutée le plus récemment ou en cours d'exécution sur ce fournisseur de types.
options nested object Options à appliquer lors de la gestion des ressources de ce service.
options.asyncOptions[] list Options concernant la création de threads pour les requêtes asynchrones.
options.asyncOptions[].methodMatch string Expression régulière de la méthode à laquelle cette règle s'applique.
options.asyncOptions[].pollingOptions nested object Deployment Manager interroge les instances de cette ressource d'API en définissant un état RUNNING et en bloquant jusqu'à ce que les conditions d'interrogation indiquent si la ressource est terminée ou a échoué.
options.asyncOptions[].pollingOptions.diagnostics[] list Tableau de diagnostics à collecter par Deployment Manager. Ces diagnostics seront affichés à l'utilisateur.
options.asyncOptions[].pollingOptions.diagnostics[].field string Expression JsonPath sur la ressource qui, si elle n'est pas vide, indique que ce champ doit être extrait en tant que diagnostic.
options.asyncOptions[].pollingOptions.diagnostics[].level string Niveau d'enregistrement de ce diagnostic.
options.asyncOptions[].pollingOptions.failCondition string Expression JSONPath qui détermine si la requête a échoué.
options.asyncOptions[].pollingOptions.finishCondition string Expression JSONPath qui détermine si la requête est terminée.
options.inputMappings[] list Mappages qui s'appliquent aux requêtes.
options.inputMappings[].fieldName string Nom du champ qui va être injecté.
options.inputMappings[].location string Lieu auquel ce mappage s'applique.
options.inputMappings[].methodMatch string Expression régulière à évaluer sur la méthode pour déterminer si l'entrée s'applique.
options.inputMappings[].value string Expression JSONPath permettant de sélectionner un élément.
options.validationOptions nested object Options permettant de valider et de traiter les propriétés d'une ressource.
options.validationOptions.schemaValidation string Personnalisez la façon dont Deployment Manager valide la ressource par rapport aux erreurs de schéma.
options.validationOptions.undeclaredProperties string Spécifiez ce qu'il faut faire avec les propriétés supplémentaires lors de l'exécution d'une requête.
options.virtualProperties string Bloc de propriétés supplémentaires décrit comme un jsonSchema. Ces propriétés ne feront jamais partie de la charge utile JSON, mais elles peuvent être utilisées par InputMappings. Il doit s'agir d'un schéma JSON draft-04 valide. Les propriétés spécifiées ici seront dissociées dans une autre section. Ce schéma sera fusionné avec la validation du schéma, et les propriétés ici seront extraites de la charge utile et consommées explicitement par InputMappings. Exemple: field1: type: string field2: type: number

Méthodes

supprimer
Supprime un fournisseur de types.
get
Obtient des informations sur un fournisseur de types spécifique.
getType
Obtient des informations sur un type fourni par un TypeProvider.
insérer
Crée un fournisseur de types.
liste
Liste tous les fournisseurs de types de ressources pour Deployment Manager.
listTypes
Répertorie toutes les informations de type pour un TypeProvider.
patch
Applique un correctif à un fournisseur de types.
update
Met à jour un fournisseur de types.