Types

Am Ende dieser Seite finden Sie eine Liste der Methoden für diese Ressource.

Ressourcendarstellungen

Ein von Deployment Manager unterstützter Ressourcentyp. 

{
  "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
    }
  ]
}
Eigenschaft Wert Beschreibung Hinweise
base nested object Basistyp (konfigurierbarer Dienst), der diesen Typ unterstützt.
base.collectionOverrides[] list Ermöglicht Überschreibungen der Ressourcenverwaltung für bestimmte Sammlungen
base.collectionOverrides[].collection string Die Sammlung, die diese Ressource innerhalb ihres Dienstes identifiziert.
base.collectionOverrides[].options nested object Die Optionen, die auf diese Überschreibung auf Ressourcenebene angewendet werden sollen
base.collectionOverrides[].options.asyncOptions[] list Optionen für die Thread-Verarbeitung asynchroner Anfragen.
base.collectionOverrides[].options.asyncOptions[].methodMatch string Regex für die Methode, auf die diese Richtlinie angewendet werden soll.
base.collectionOverrides[].options.asyncOptions[].pollingOptions nested object Deployment Manager fragt Instanzen für diese API-Ressource ab, setzt den Status auf „RUNNING“ (LÄUFT) und blockiert, bis die Abfragebedingungen angeben, ob die Ressource abgeschlossen oder fehlgeschlagen ist.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[] list Eine Reihe von Diagnosen, die von Deployment Manager erfasst werden. Diese Diagnosen werden dem Nutzer angezeigt.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].field string JSONPath-Ausdruck für die Ressource, der angibt, dass dieses Feld als Diagnose extrahiert werden muss.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].level string Ebene, auf der diese Diagnose aufgezeichnet werden soll.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.failCondition string JSONPath-Ausdruck, der bestimmt, ob die Anfrage fehlgeschlagen ist.
base.collectionOverrides[].options.asyncOptions[].pollingOptions.finishCondition string JSONPath-Ausdruck, der bestimmt, ob die Anfrage abgeschlossen ist.
base.collectionOverrides[].options.inputMappings[] list Die Zuordnungen, die für Anfragen gelten.
base.collectionOverrides[].options.inputMappings[].fieldName string Der Name des Felds, das eingefügt werden soll.
base.collectionOverrides[].options.inputMappings[].location string Der Ort, für den diese Zuordnung gilt.
base.collectionOverrides[].options.inputMappings[].methodMatch string Regex, der anhand der Methode ausgewertet wird, um zu entscheiden, ob die Eingabe zutrifft.
base.collectionOverrides[].options.inputMappings[].value string Ein JSONPath-Ausdruck zum Auswählen eines Elements.
base.collectionOverrides[].options.validationOptions nested object Optionen zum Validieren und Verarbeiten von Properties in einer Ressource.
base.collectionOverrides[].options.validationOptions.schemaValidation string Sie können anpassen, wie Deployment Manager die Ressource auf Schemafehler prüft.
base.collectionOverrides[].options.validationOptions.undeclaredProperties string Hier legen Sie fest, was mit zusätzlichen Properties bei der Ausführung einer Anfrage geschehen soll.
base.collectionOverrides[].options.virtualProperties string Block mit zusätzlichen Properties, der als JSON-Schema beschrieben ist. Diese Properties sind nie Teil der JSON-Nutzlast, können aber von InputMappings verwendet werden. Dies muss ein gültiges JSON-Schema vom Typ „draft-04“ sein. Die hier angegebenen Properties werden in einem anderen Abschnitt getrennt. Dieses Schema wird mit der Schemavalidierung zusammengeführt. Die darin enthaltenen Properties werden aus der Nutzlast extrahiert und explizit von InputMappings verwendet. Beispiel: field1: type: string field2: type: number
base.credential nested object Anmeldedaten, die für die Interaktion mit diesem Typ verwendet werden.
base.credential.basicAuth nested object Anmeldedaten für die Basisauthentifizierung, die nur vom TypeProvider verwendet werden.
base.credential.basicAuth.password string
base.credential.basicAuth.user string
base.credential.serviceAccount nested object Anmeldedaten für ein Dienstkonto, die nur von der Bereitstellung verwendet werden.
base.credential.serviceAccount.email string Die E-Mail-Adresse des IAM-Dienstkontos, z. B. test@myproject.iam.gserviceaccount.com
base.credential.useProjectDefault boolean Hier können Sie angeben, dass die Standardanmeldedaten des Projekts verwendet werden sollen. Diese werden nur vom Deployment unterstützt.
base.descriptorUrl string Deskriptor-URL für diesen Typ.
base.options nested object Optionen, die beim Umgang mit Ressourcen in diesem Dienst angewendet werden können.
base.options.asyncOptions[] list Optionen für die Thread-Verarbeitung asynchroner Anfragen.
base.options.asyncOptions[].methodMatch string Regex für die Methode, auf die diese Richtlinie angewendet werden soll.
base.options.asyncOptions[].pollingOptions nested object Deployment Manager fragt Instanzen für diese API-Ressource ab, setzt den Status auf „RUNNING“ (LÄUFT) und blockiert, bis die Abfragebedingungen angeben, ob die Ressource abgeschlossen oder fehlgeschlagen ist.
base.options.asyncOptions[].pollingOptions.diagnostics[] list Eine Reihe von Diagnosen, die von Deployment Manager erfasst werden. Diese Diagnosen werden dem Nutzer angezeigt.
base.options.asyncOptions[].pollingOptions.diagnostics[].field string JSONPath-Ausdruck für die Ressource, der angibt, dass dieses Feld als Diagnose extrahiert werden muss.
base.options.asyncOptions[].pollingOptions.diagnostics[].level string Ebene, auf der diese Diagnose aufgezeichnet werden soll.
base.options.asyncOptions[].pollingOptions.failCondition string JSONPath-Ausdruck, der bestimmt, ob die Anfrage fehlgeschlagen ist.
base.options.asyncOptions[].pollingOptions.finishCondition string JSONPath-Ausdruck, der bestimmt, ob die Anfrage abgeschlossen ist.
base.options.inputMappings[] list Die Zuordnungen, die für Anfragen gelten.
base.options.inputMappings[].fieldName string Der Name des Felds, das eingefügt werden soll.
base.options.inputMappings[].location string Der Ort, für den diese Zuordnung gilt.
base.options.inputMappings[].methodMatch string Regex, der anhand der Methode ausgewertet wird, um zu entscheiden, ob die Eingabe zutrifft.
base.options.inputMappings[].value string Ein JSONPath-Ausdruck zum Auswählen eines Elements.
base.options.validationOptions nested object Optionen zum Validieren und Verarbeiten von Properties in einer Ressource.
base.options.validationOptions.schemaValidation string Sie können anpassen, wie Deployment Manager die Ressource auf Schemafehler prüft.
base.options.validationOptions.undeclaredProperties string Hier legen Sie fest, was mit zusätzlichen Properties bei der Ausführung einer Anfrage geschehen soll.
base.options.virtualProperties string Block mit zusätzlichen Properties, der als JSON-Schema beschrieben ist. Diese Properties sind nie Teil der JSON-Nutzlast, können aber von InputMappings verwendet werden. Dies muss ein gültiges JSON-Schema vom Typ „draft-04“ sein. Die hier angegebenen Properties werden in einem anderen Abschnitt getrennt. Dieses Schema wird mit der Schemavalidierung zusammengeführt. Die darin enthaltenen Properties werden aus der Nutzlast extrahiert und explizit von InputMappings verwendet. Beispiel: field1: type: string field2: type: number
description string Eine optionale Textbeschreibung der Ressource; wird vom Client bei der Erstellung der Ressource bereitgestellt.
id unsigned long
insertTime string Nur Ausgabe. Erstellungszeitstempel im Textformat RFC3339.
labels[] list Zuordnung von Labels; vom Client beim Erstellen oder Aktualisieren der Ressource bereitgestellt. Im Detail: Labelschlüssel müssen zwischen 1 und 63 Zeichen lang sein und dem folgenden regulären Ausdruck entsprechen: `[a-z]([-a-z0-9]*[a-z0-9])?`. Labelwerte müssen zwischen 0 und 63 Zeichen lang sein und dem regulären Ausdruck `([a-z]([-a-z0-9]*[a-z0-9])?)?` entsprechen.

labels[].key string
labels[].value string
name string Name des Typs.
operation nested object Nur Ausgabe. Der Vorgang, der für diesen Typ zuletzt ausgeführt wurde oder gerade ausgeführt wird.

Methoden

list
Listet alle Ressourcentypen für Deployment Manager auf.