REST Resource: projects.locations.customTargetTypes

Ressource: CustomTargetType

Eine CustomTargetType-Ressource in der Cloud Deploy API.

Ein CustomTargetType definiert einen Typ von benutzerdefiniertem Ziel, auf das in einer Target verwiesen werden kann, um die Bereitstellung auf anderen Systemen außer den unterstützten Laufzeiten zu erleichtern.

JSON-Darstellung 
{
  "name": string,
  "customTargetTypeId": string,
  "uid": string,
  "description": string,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,

  // Union field definition can be only one of the following:
  "customActions": {
    object (CustomTargetSkaffoldActions)
  }
  // End of list of possible types for union field definition.
}
Felder
name

string

Optional. Name von CustomTargetType. Das Format ist projects/{project}/locations/{location}/customTargetTypes/{customTargetType}. Die Komponente „customTargetType“ muss mit „[a-z]([a-z0-9-]{0,61}[a-z0-9])?“ übereinstimmen
customTargetTypeId

string

Nur Ausgabe. Ressourcen-ID von CustomTargetType.
uid

string

Nur Ausgabe. Eindeutige Kennung von CustomTargetType.
description

string

Optional. Beschreibung von CustomTargetType. Maximale Länge: 255 Zeichen
annotations

map (key: string, value: string)

Optional. Nutzeranmerkungen Diese Attribute können nur vom Nutzer und nicht von Cloud Deploy festgelegt und verwendet werden. Weitere Informationen zu Format- und Größenbeschränkungen findest du unter https://google.aip.dev/128#annotations.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labels

map (key: string, value: string)

Optional. Labels sind Attribute, die sowohl vom Nutzer als auch von Cloud Deploy festgelegt und verwendet werden können. Labels müssen die folgenden Einschränkungen erfüllen:

  • Schlüssel und Werte dürfen nur Kleinbuchstaben, numerische Zeichen, Unterstriche und Bindestriche enthalten.
  • Alle Zeichen müssen die UTF-8-Codierung verwenden; internationale Zeichen sind zulässig.
  • Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen.
  • Jede Ressource ist auf maximal 64 Labels beschränkt.

Sowohl Schlüssel als auch Werte sind zusätzlich auf maximal 128 Byte beschränkt.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem das CustomTargetType erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt der letzten Aktualisierung des CustomTargetType.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
etag

string

Optional. Diese Prüfsumme wird vom Server basierend auf dem Wert anderer Felder berechnet und kann bei Aktualisierungs- und Löschanfragen gesendet werden, um sicherzustellen, dass der Client vor dem Fortfahren über einen aktuellen Wert verfügt.
Union-Feld definition. Definiert den CustomTargetType-Renderer und -Bereitsteller. Für definition ist nur einer der folgenden Werte zulässig:
customActions

object (CustomTargetSkaffoldActions)

Konfiguriert das Rendering und die Bereitstellung für CustomTargetType mithilfe von benutzerdefinierten Skaffold-Aktionen.

CustomTargetSkaffoldActions

CustomTargetSkaffoldActions stellt die CustomTargetType-Konfiguration unter Verwendung von benutzerdefinierten Skaffold-Aktionen dar.

JSON-Darstellung 
{
  "renderAction": string,
  "deployAction": string,
  "includeSkaffoldModules": [
    {
      object (SkaffoldModules)
    }
  ]
}
Felder
renderAction

string

Optional. Die benutzerdefinierte Skaffold-Aktion für Renderingvorgänge. Wenn nicht angegeben, führt Cloud Deploy die Renderingvorgänge über skaffold render aus.
deployAction

string

Erforderlich. Die benutzerdefinierte Skaffold-Aktion für Bereitstellungsvorgänge.
includeSkaffoldModules[]

object (SkaffoldModules)

Optional. Liste der Skaffold-Module, die Cloud Deploy vor der Diagnose in die Skaffold-Konfiguration aufnehmen wird.

SkaffoldModules

Skaffold-Konfigurationsmodule und ihre Remote-Quelle.

JSON-Darstellung 
{
  "configs": [
    string
  ],

  // Union field source can be only one of the following:
  "git": {
    object (SkaffoldGitSource)
  },
  "googleCloudStorage": {
    object (SkaffoldGCSSource)
  },
  "googleCloudBuildRepo": {
    object (SkaffoldGCBRepoSource)
  }
  // End of list of possible types for union field source.
}
Felder
configs[]

string

Optional. Die Skaffold-Konfigurationsmodule, die aus der angegebenen Quelle verwendet werden sollen.
Union-Feld source. Die Quelle, die die Skaffold-Konfigurationsmodule enthält. Für source ist nur einer der folgenden Werte zulässig:
git

object (SkaffoldGitSource)

Remote-Git-Repository, das die Skaffold-Konfigurationsmodule enthält.
googleCloudStorage

object (SkaffoldGCSSource)

Cloud Storage-Bucket mit den Skaffold-Konfigurationsmodulen.
googleCloudBuildRepo

object (SkaffoldGCBRepoSource)

Cloud Build V2-Repository mit den Skaffold-Konfigurationsmodulen.

SkaffoldGitSource

Git-Repository mit Skaffold-Konfigurationsmodulen.

JSON-Darstellung 
{
  "repo": string,
  "path": string,
  "ref": string
}
Felder
repo

string

Erforderlich. Git-Repository, aus dem das Paket geklont werden soll.
path

string

Optional. Relativer Pfad vom Repository-Stamm zur Skaffold-Datei.
ref

string

Optional. Git-Zweig oder -Tag zum Klonen des Repositorys.

SkaffoldGCSSource

Cloud Storage-Bucket mit Skaffold-Konfigurationsmodulen.

JSON-Darstellung 
{
  "source": string,
  "path": string
}
Felder
source

string

Erforderlich. Cloud Storage-Quellpfade, die rekursiv kopiert werden sollen. Wenn Sie beispielsweise „gs://my-bucket/dir/configs/*“ angeben, kopiert Skaffold alle Dateien aus dem Verzeichnis „dir/configs“ im Bucket „my-bucket“.
path

string

Optional. Relativer Pfad von der Quelle zur Skaffold-Datei.

SkaffoldGCBRepoSource

Cloud Build V2-Repository mit Skaffold-Konfigurationen.

JSON-Darstellung 
{
  "repository": string,
  "path": string,
  "ref": string
}
Felder
repository

string

Erforderlich. Name des Cloud Build V2-Repositorys. Das Format ist „projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}.“
path

string

Optional. Relativer Pfad vom Repository-Stamm zur Skaffold-Konfigurationsdatei.
ref

string

Optional. Zweig oder Tag zum Klonen des Repositorys.

Methoden

create

 Erstellt einen neuen CustomTargetType in einem bestimmten Projekt und an einem bestimmten Standort.

delete

 Löscht einen einzelnen CustomTargetType.

get

 Ruft Details zu einem einzelnen CustomTargetType ab.

getIamPolicy

 Ruft die Richtlinie für die Zugriffssteuerung für eine Ressource ab.

list

 Listet CustomTargetTypes in einem bestimmten Projekt und an einem bestimmten Standort auf.

patch

 Aktualisiert einen einzelnen CustomTargetType.

setIamPolicy

 Legt die Richtlinie für die Zugriffssteuerung für die angegebene Ressource fest.