REST Resource: projects.locations.targets

Ressource: Ziel

Eine Target-Ressource in der Cloud Deploy API.

Ein Target definiert einen Standort, an dem eine Skaffold-Konfiguration bereitgestellt werden kann.

JSON-Darstellung 
{
  "name": string,
  "targetId": string,
  "uid": string,
  "description": string,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "requireApproval": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionConfigs": [
    {
      object (ExecutionConfig)
    }
  ],
  "deployParameters": {
    string: string,
    ...
  },

  // Union field deployment_target can be only one of the following:
  "gke": {
    object (GkeCluster)
  },
  "anthosCluster": {
    object (AnthosCluster)
  },
  "run": {
    object (CloudRunLocation)
  },
  "multiTarget": {
    object (MultiTarget)
  },
  "customTarget": {
    object (CustomTarget)
  }
  // End of list of possible types for union field deployment_target.
}
Felder
name

string

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

string

Nur Ausgabe. Ressourcen-ID von Target.
uid

string

Nur Ausgabe. Eindeutige Kennung von Target.
description

string

Optional. Beschreibung von Target. 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" }.
requireApproval

boolean

Optional. Gibt an, ob für Target eine Genehmigung erforderlich ist.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem das Target 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 Target.

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.
executionConfigs[]

object (ExecutionConfig)

Konfigurationen für alle Ausführungen, die sich auf dieses Target beziehen. Jeder ExecutionEnvironmentUsage-Wert darf nur in einer einzelnen Konfiguration verwendet werden. Die mehrmalige Verwendung desselben Werts stellt einen Fehler dar. Wenn eine oder mehrere Konfigurationen angegeben sind, müssen diese die ExecutionEnvironmentUsage-Werte RENDER und DEPLOY enthalten. Wenn keine Konfigurationen angegeben sind, verwendet die Ausführung den in DefaultPool angegebenen Standardwert.
deployParameters

map (key: string, value: string)

Optional. Die Bereitstellungsparameter, die für dieses Ziel verwendet werden sollen.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Union-Feld deployment_target. Ziel, auf das die Skaffold-Konfiguration während eines Roll-outs angewendet wird. Für deployment_target ist nur einer der folgenden Werte zulässig:
gke

object (GkeCluster)

Optional. Informationen zum Festlegen eines GKE-Clusters.
anthosCluster

object (AnthosCluster)

Optional. Informationen zum Angeben eines Anthos-Clusters.
run

object (CloudRunLocation)

Optional. Informationen zum Angeben eines Cloud Run-Bereitstellungsziels.
multiTarget

object (MultiTarget)

Optional. Informationen zum Festlegen eines MultiTarget-Ziels.
customTarget

object (CustomTarget)

Optional. Informationen zum Festlegen eines benutzerdefinierten Ziels.

GkeCluster

Informationen zum Festlegen eines GKE-Clusters.

JSON-Darstellung 
{
  "cluster": string,
  "internalIp": boolean
}
Felder
cluster

string

Optional. Informationen zum Festlegen eines GKE-Clusters. Format ist projects/{projectId}/locations/{locationId}/clusters/{cluster_id}.
internalIp

boolean

Optional. Bei „true“ wird über die private IP-Adresse des Endpunkts der Steuerungsebene auf cluster zugegriffen. Andernfalls wird die Standard-IP-Adresse des Endpunkts der Steuerungsebene verwendet. Die Standard-IP-Adresse ist die private IP-Adresse für Cluster mit Endpunkten der privaten Steuerungsebene, andernfalls die öffentliche IP-Adresse.

Geben Sie diese Option nur an, wenn cluster ein privater GKE-Cluster ist.

AnthosCluster

Informationen zum Angeben eines Anthos-Clusters.

JSON-Darstellung 
{
  "membership": string
}
Felder
membership

string

Optional. Mitgliedschaft des von GKE Hub registrierten Clusters, auf den die Skaffold-Konfiguration angewendet werden soll. Format ist projects/{project}/locations/{location}/memberships/{membership_name}.

CloudRunLocation

Informationen zum Bereitstellen eines Cloud Run-Dienstes.

JSON-Darstellung 
{
  "location": string
}
Felder
location

string

Erforderlich. Der Standort für den Cloud Run-Dienst. Das Format muss projects/{project}/locations/{location} sein.

MultiTarget

Informationen zum Festlegen eines MultiTarget-Ziels.

JSON-Darstellung 
{
  "targetIds": [
    string
  ]
}
Felder
targetIds[]

string

Erforderlich. Die targetIds dieses MultiTargets.

CustomTarget

Informationen zum Festlegen eines benutzerdefinierten Ziels.

JSON-Darstellung 
{
  "customTargetType": string
}
Felder
customTargetType

string

Erforderlich. Der Name von CustomTargetType. Das Format muss projects/{project}/locations/{location}/customTargetTypes/{customTargetType} sein.

ExecutionConfig

Konfiguration der Umgebung, die beim Aufrufen von Skaffold verwendet werden soll.

JSON-Darstellung 
{
  "usages": [
    enum (ExecutionEnvironmentUsage)
  ],
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string,
  "executionTimeout": string,
  "verbose": boolean,

  // Union field execution_environment can be only one of the following:
  "defaultPool": {
    object (DefaultPool)
  },
  "privatePool": {
    object (PrivatePool)
  }
  // End of list of possible types for union field execution_environment.
}
Felder
usages[]

enum (ExecutionEnvironmentUsage)

Erforderlich. Nutzung, bei der diese Konfiguration angewendet werden soll.
workerPool

string

Optional. Der Ressourcenname von WorkerPool im Format projects/{project}/locations/{location}/workerPools/{workerPool}. Wenn dieses optionale Feld nicht angegeben ist, wird der Cloud Build-Standardpool verwendet.
serviceAccount

string

Optional. Google-Dienstkonto, das zur Ausführung verwendet werden soll. Wenn keine Vorgabe erfolgt, wird das Dienstkonto für die Projektausführung (-compute@developer.gserviceaccount.com) verwendet.
artifactStorage

string

Optional. Cloud Storage-Speicherort, an dem die Ausführungsausgaben gespeichert werden sollen. Dies kann entweder ein Bucket („gs://my-bucket“) oder ein Pfad innerhalb eines Buckets („gs://my-bucket/my-dir“) sein. Wenn keine Angabe gemacht wird, wird ein Standard-Bucket in derselben Region verwendet.
executionTimeout

string (Duration format)

Optional. Zeitlimit für die Ausführung einer Cloud Build Execution. Der Wert muss zwischen 10 und 24 Stunden im Sekundenformat liegen. Wenn keine Vorgabe erfolgt, wird ein Standardzeitlimit von 1 h verwendet.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
verbose

boolean

Optional. Bei „true“ wird für Cloud Build-Ausführungen, die in dieser Ausführungsumgebung ausgeführt werden, zusätzliches Logging aktiviert.
Union-Feld execution_environment. Details zur Umgebung Für execution_environment ist nur einer der folgenden Werte zulässig:
defaultPool

object (DefaultPool)

Optional. Cloud Build-Standardpool verwenden.
privatePool

object (PrivatePool)

Optional. Privaten Cloud Build-Pool verwenden.

ExecutionEnvironmentUsage

Mögliche Verwendungen dieser Konfiguration.

Enums
EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
RENDER Für Rendering verwenden.
DEPLOY Wird für Bereitstellungs- und Bereitstellungs-Hooks verwendet.
VERIFY Für die Überprüfung der Bereitstellung verwenden.
PREDEPLOY Wird für die Ausführung von Jobs vor dem Deployment verwendet.
POSTDEPLOY Wird zur Ausführung von Jobs nach dem Deployment verwendet.

DefaultPool

Ausführung mit dem Cloud Build-Standardpool.

JSON-Darstellung 
{
  "serviceAccount": string,
  "artifactStorage": string
}
Felder
serviceAccount

string

Optional. Google-Dienstkonto, das zur Ausführung verwendet werden soll. Wenn keine Vorgabe erfolgt, wird das Dienstkonto für die Projektausführung (-compute@developer.gserviceaccount.com) verwendet.
artifactStorage

string

Optional. Cloud Storage-Speicherort, an dem die Ausführungsausgaben gespeichert werden sollen. Dies kann entweder ein Bucket („gs://my-bucket“) oder ein Pfad innerhalb eines Buckets („gs://my-bucket/my-dir“) sein. Wenn keine Angabe gemacht wird, wird ein Standard-Bucket in derselben Region verwendet.

PrivatePool

Ausführung mit einem privaten Cloud Build-Pool.

JSON-Darstellung 
{
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string
}
Felder
workerPool

string

Erforderlich. Ressourcenname des zu verwendenden Cloud Build-Worker-Pools. Das Format dafür ist projects/{project}/locations/{location}/workerPools/{pool}.
serviceAccount

string

Optional. Google-Dienstkonto, das zur Ausführung verwendet werden soll. Wenn keine Vorgabe erfolgt, wird das Dienstkonto für die Projektausführung (-compute@developer.gserviceaccount.com) verwendet.
artifactStorage

string

Optional. Cloud Storage-Speicherort, an dem die Ausführungsausgaben gespeichert werden sollen. Dies kann entweder ein Bucket („gs://my-bucket“) oder ein Pfad innerhalb eines Buckets („gs://my-bucket/my-dir“) sein. Wenn keine Angabe gemacht wird, wird ein Standard-Bucket in derselben Region verwendet.

Methoden

create

 Erstellt ein neues Ziel in einem bestimmten Projekt und an einem bestimmten Standort.

delete

 Löscht ein einzelnes Ziel.

get

 Ruft Details zu einem einzelnen Ziel ab

getIamPolicy

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

list

 Listet Ziele in einem bestimmten Projekt und an einem bestimmten Standort auf

patch

 Aktualisiert die Parameter eines einzelnen Ziels.

setIamPolicy

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

testIamPermissions

 Gibt die Berechtigungen des Aufrufers für die angegebene Ressource zurück.