REST Resource: projects.locations.deliveryPipelines.targets

Ressource: Ziel

Eine Target-Ressource in der Google 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)
    }
  ],

  // Union field deployment_target can be only one of the following:
  "gkeCluster": {
    object (GKECluster)
  },
  "cluster": {
    object (GkeCluster)
  },
  "gke": {
    object (GkeCluster)
  }
  // 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}/ deliveryPipelines/{deliveryPipeline}/targets/[a-z][a-z0-9-]{0,62}.
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 Google 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 Google Cloud Deploy festgelegt und verwendet werden können. Labels müssen die folgenden Einschränkungen erfüllen: Jede Ressource ist auf 64 Labels beschränkt. Schlüssel müssen dem Regexp entsprechen: [a-zA-Z][a-zA-Z0-9_-]{0,62} Die Werte müssen dem Regexp entsprechen: [a-zA-Z0-9_-]{0,63} Beide Schlüssel und Werte sind zusätzlich auf eine Größe von 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.
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:
gkeCluster

object (GKECluster)

Informationen zum Festlegen eines GKE-Clusters.
cluster

object (GkeCluster)

Informationen zum Festlegen eines GKE-Clusters.
gke

object (GkeCluster)

Informationen zum Festlegen eines GKE-Clusters.

GKECluster

Informationen zum Festlegen eines GKE-Clusters.

JSON-Darstellung 
{
  "project": string,
  "cluster": string,
  "location": string
}
Felder
project

string

Projekt, in dem sich der Cluster befindet.
cluster

string

Name des Clusters.
location

string

Speicherort des Clusters.

GkeCluster

Informationen zum Festlegen eines GKE-Clusters.

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

string

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

ExecutionConfig

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

JSON-Darstellung 
{
  "usages": [
    enum (ExecutionEnvironmentUsage)
  ],

  // 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.
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.

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 freigegebenes Ziel.

get

 Ruft Details zu einem einzelnen gemeinsamen Ziel ab

list

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

patch

 Aktualisiert die Parameter eines gemeinsamen einzelnen Ziels.