TypeProviders

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

Ressourcendarstellungen

Ein Typanbieter, der einen servicegestützten Typ beschreibt. 

{
  "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
  ]
}
Eigenschaft Wert Beschreibung Hinweise
collectionOverrides[] list Ermöglicht Überschreibungen der Ressourcenverwaltung für bestimmte Sammlungen
collectionOverrides[].collection string Die Sammlung, die diese Ressource innerhalb ihres Dienstes identifiziert.
collectionOverrides[].options nested object Die Optionen, die auf diese Überschreibung auf Ressourcenebene angewendet werden sollen
collectionOverrides[].options.asyncOptions[] list Optionen für die Thread-Verarbeitung asynchroner Anfragen.
collectionOverrides[].options.asyncOptions[].methodMatch string Regex für die Methode, auf die diese Richtlinie angewendet werden soll.
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.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[] list Eine Reihe von Diagnosen, die von Deployment Manager erfasst werden. Diese Diagnosen werden dem Nutzer angezeigt.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].field string JSONPath-Ausdruck für die Ressource, der angibt, dass dieses Feld als Diagnose extrahiert werden muss.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].level string Ebene, auf der diese Diagnose aufgezeichnet werden soll.
collectionOverrides[].options.asyncOptions[].pollingOptions.failCondition string JSONPath-Ausdruck, der bestimmt, ob die Anfrage fehlgeschlagen ist.
collectionOverrides[].options.asyncOptions[].pollingOptions.finishCondition string JSONPath-Ausdruck, der bestimmt, ob die Anfrage abgeschlossen ist.
collectionOverrides[].options.inputMappings[] list Die Zuordnungen, die für Anfragen gelten.
collectionOverrides[].options.inputMappings[].fieldName string Der Name des Felds, das eingefügt werden soll.
collectionOverrides[].options.inputMappings[].location string Der Ort, für den diese Zuordnung gilt.
collectionOverrides[].options.inputMappings[].methodMatch string Regex, der anhand der Methode ausgewertet wird, um zu entscheiden, ob die Eingabe zutrifft.
collectionOverrides[].options.inputMappings[].value string Ein JSONPath-Ausdruck zum Auswählen eines Elements.
collectionOverrides[].options.validationOptions nested object Optionen zum Validieren und Verarbeiten von Properties in einer Ressource.
collectionOverrides[].options.validationOptions.schemaValidation string Sie können anpassen, wie Deployment Manager die Ressource auf Schemafehler prüft.
collectionOverrides[].options.validationOptions.undeclaredProperties string Hier legen Sie fest, was mit zusätzlichen Properties bei der Ausführung einer Anfrage geschehen soll.
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
credential nested object Anmeldedaten, die für die Interaktion mit diesem Typ verwendet werden.
credential.basicAuth nested object Anmeldedaten für die Basisauthentifizierung, die nur vom TypeProvider verwendet werden.
credential.basicAuth.password string
credential.basicAuth.user string
credential.serviceAccount nested object Anmeldedaten für ein Dienstkonto, die nur von der Bereitstellung verwendet werden.
credential.serviceAccount.email string Die E-Mail-Adresse des IAM-Dienstkontos, z. B. test@myproject.iam.gserviceaccount.com
credential.useProjectDefault boolean Hier können Sie angeben, dass die Standardanmeldedaten des Projekts verwendet werden sollen. Diese werden nur vom Deployment unterstützt.
customCertificateAuthorityRoots[] list Liste von bis zu zwei Stammzertifizierungsstellen, die für die TLS-Authentifizierung bei Aufrufen im Namen dieses Typanbieters verwendet werden sollen. Wenn diese Einstellung festgelegt ist, werden bei der TLS-Authentifizierung ausschließlich diese Stammzertifikate verwendet, anstatt sich bei der Validierung der TLS-Zertifikatsauthentizität auf öffentlich vertrauenswürdige Zertifizierungsstellen zu verlassen. Die Zertifikate müssen im Base64-codierten PEM-Format vorliegen. Die maximale Größe jedes Zertifikats darf 10 KB nicht überschreiten.
description string Eine optionale Textbeschreibung der Ressource; wird vom Client bei der Erstellung der Ressource bereitgestellt.
descriptorUrl string Deskriptor-URL für diesen Typanbieter.
id unsigned long Nur Ausgabe. Die vom Server definierte eindeutige Kennung für die Ressource.
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 der Ressource, angegeben vom Client beim Erstellen der Ressource. Der Name muss zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Insbesondere muss der Name 1–63 Zeichen lang sein und mit dem regulären Ausdruck `[a-z]([-a-z0-9]*[a-z0-9])?` übereinstimmen. Das heißt, das erste Zeichen muss ein Kleinbuchstabe und alle folgenden Zeichen müssen aus Bindestrichen, Kleinbuchstaben und Ziffern bestehen. Das letzte Zeichen darf kein Bindestrich sein.
operation nested object Nur Ausgabe. Die Operation, die zuletzt oder derzeit bei diesem Typanbieter ausgeführt wurde.
options nested object Optionen, die beim Umgang mit Ressourcen in diesem Dienst angewendet werden können.
options.asyncOptions[] list Optionen für die Thread-Verarbeitung asynchroner Anfragen.
options.asyncOptions[].methodMatch string Regex für die Methode, auf die diese Richtlinie angewendet werden soll.
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.
options.asyncOptions[].pollingOptions.diagnostics[] list Eine Reihe von Diagnosen, die von Deployment Manager erfasst werden. Diese Diagnosen werden dem Nutzer angezeigt.
options.asyncOptions[].pollingOptions.diagnostics[].field string JSONPath-Ausdruck für die Ressource, der angibt, dass dieses Feld als Diagnose extrahiert werden muss.
options.asyncOptions[].pollingOptions.diagnostics[].level string Ebene, auf der diese Diagnose aufgezeichnet werden soll.
options.asyncOptions[].pollingOptions.failCondition string JSONPath-Ausdruck, der bestimmt, ob die Anfrage fehlgeschlagen ist.
options.asyncOptions[].pollingOptions.finishCondition string JSONPath-Ausdruck, der bestimmt, ob die Anfrage abgeschlossen ist.
options.inputMappings[] list Die Zuordnungen, die für Anfragen gelten.
options.inputMappings[].fieldName string Der Name des Felds, das eingefügt werden soll.
options.inputMappings[].location string Der Ort, für den diese Zuordnung gilt.
options.inputMappings[].methodMatch string Regex, der anhand der Methode ausgewertet wird, um zu entscheiden, ob die Eingabe zutrifft.
options.inputMappings[].value string Ein JSONPath-Ausdruck zum Auswählen eines Elements.
options.validationOptions nested object Optionen zum Validieren und Verarbeiten von Properties in einer Ressource.
options.validationOptions.schemaValidation string Sie können anpassen, wie Deployment Manager die Ressource auf Schemafehler prüft.
options.validationOptions.undeclaredProperties string Hier legen Sie fest, was mit zusätzlichen Properties bei der Ausführung einer Anfrage geschehen soll.
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

Methoden

Delete
Löscht einen Typanbieter.
get
Ruft Informationen zu einem bestimmten Typanbieter ab.
getType
Ruft Informationen zu einem Typ ab, der von einem Typanbieter bereitgestellt wird.
insert
Erstellt einen Typanbieter.
list
Listet alle Ressourcentypanbieter für Deployment Manager auf.
listTypes
Listet alle Typinformationen für einen TypeProvider auf.
patch
Patcht einen Typanbieter.
aktualisieren
Aktualisiert einen Typanbieter.