Types

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

Représentations de la ressource

Type de ressource compatible avec 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
    }
  ]
}
Nom de propriété Valeur Description Remarques
base nested object Type de base (service configurable) qui sous-tend ce type.
base.collectionOverrides[] list Permet de remplacer la gestion des ressources pour des collections spécifiques
base.collectionOverrides[].collection string Collection qui identifie cette ressource dans son service.
base.collectionOverrides[].options nested object Options à appliquer à ce forçage au niveau de la ressource
base.collectionOverrides[].options.asyncOptions[] list Options concernant la création de threads pour les requêtes asynchrones.
base.collectionOverrides[].options.asyncOptions[].methodMatch string Expression régulière de la méthode à laquelle cette règle s'applique.
base.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é.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[] list Tableau de diagnostics à collecter par Deployment Manager. Ces diagnostics seront affichés à l'utilisateur.
base.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.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].level string Niveau d'enregistrement de ce diagnostic.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.failCondition string Expression JSONPath qui détermine si la requête a échoué.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.finishCondition string Expression JSONPath qui détermine si la requête est terminée.
base.collectionOverrides[].options.inputMappings[] list Mappages qui s'appliquent aux requêtes.
base.collectionOverrides[].options.inputMappings[].fieldName string Nom du champ qui va être injecté.
base.collectionOverrides[].options.inputMappings[].location string Lieu auquel ce mappage s'applique.
base.collectionOverrides[].options.inputMappings[].methodMatch string Expression régulière à évaluer sur la méthode pour déterminer si l'entrée s'applique.
base.collectionOverrides[].options.inputMappings[].value string Expression JSONPath permettant de sélectionner un élément.
base.collectionOverrides[].options.validationOptions nested object Options permettant de valider et de traiter les propriétés d'une ressource.
base.collectionOverrides[].options.validationOptions.schemaValidation string Personnalisez la façon dont Deployment Manager valide la ressource par rapport aux erreurs de schéma.
base.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.
base.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
base.credential nested object Identifiants utilisés lors de l'interaction avec ce type.
base.credential.basicAuth nested object Identifiants d'authentification de base, utilisés uniquement par TypeProvider.
base.credential.basicAuth.password string
base.credential.basicAuth.user string
base.credential.serviceAccount nested object Identifiants du compte de service, utilisés uniquement par le déploiement.
base.credential.serviceAccount.email string L'adresse e-mail du compte de service IAM, par exemple test@monprojet.iam.gserviceaccount.com
base.credential.useProjectDefault boolean Spécifiez d'utiliser les identifiants par défaut du projet, qui ne sont acceptés que par le déploiement.
base.descriptorUrl string URL du descripteur de ce type.
base.options nested object Options à appliquer lors de la gestion des ressources de ce service.
base.options.asyncOptions[] list Options concernant la création de threads pour les requêtes asynchrones.
base.options.asyncOptions[].methodMatch string Expression régulière de la méthode à laquelle cette règle s'applique.
base.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é.
base.options.asyncOptions[].pollingOptions.diagnostics[] list Tableau de diagnostics à collecter par Deployment Manager. Ces diagnostics seront affichés à l'utilisateur.
base.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.
base.options.asyncOptions[].pollingOptions.diagnostics[].level string Niveau d'enregistrement de ce diagnostic.
base.options.asyncOptions[].pollingOptions.failCondition string Expression JSONPath qui détermine si la requête a échoué.
base.options.asyncOptions[].pollingOptions.finishCondition string Expression JSONPath qui détermine si la requête est terminée.
base.options.inputMappings[] list Mappages qui s'appliquent aux requêtes.
base.options.inputMappings[].fieldName string Nom du champ qui va être injecté.
base.options.inputMappings[].location string Lieu auquel ce mappage s'applique.
base.options.inputMappings[].methodMatch string Expression régulière à évaluer sur la méthode pour déterminer si l'entrée s'applique.
base.options.inputMappings[].value string Expression JSONPath permettant de sélectionner un élément.
base.options.validationOptions nested object Options permettant de valider et de traiter les propriétés d'une ressource.
base.options.validationOptions.schemaValidation string Personnalisez la façon dont Deployment Manager valide la ressource par rapport aux erreurs de schéma.
base.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.
base.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
description string Description textuelle facultative de la ressource qui est fournie par le client lors de la création de cette dernière.
id unsigned long
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 du type.
operation nested object Uniquement en sortie. Opération exécutée le plus récemment ou en cours d'exécution sur ce type.

Méthodes

liste
Liste tous les types de ressources pour Deployment Manager.