REST Resource: projects.locations.deliveryPipelines.targets

Ressource: Target

Une ressource Target dans l'API Google Cloud Deploy

Un Target définit un emplacement où une configuration Skaffold peut être déployée.

Représentation JSON 
{
  "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.
}
Champs
name

string

Facultatif. Nom du Target. Le format est le suivant : projects/{project}/locations/{location}/ deliveryPipelines/{deliveryPipeline}/targets/[a-z][a-z0-9-]{0,62}.
targetId

string

Uniquement en sortie. ID de ressource de Target.
uid

string

Uniquement en sortie. Identifiant unique du Target.
description

string

Facultatif. Description de Target. Ne doit pas dépasser 255 caractères
annotations

map (key: string, value: string)

Facultatif. Annotations utilisateur Ces attributs ne peuvent être définis et utilisés que par l'utilisateur, et non par Google Cloud Deploy. Consultez https://google.aip.dev/128#annotations pour en savoir plus sur les limites de format et de taille.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labels

map (key: string, value: string)

Facultatif. Les étiquettes sont des attributs qui peuvent être définis et utilisés à la fois par l'utilisateur et par Google Cloud Deploy. Les étiquettes doivent respecter les contraintes suivantes: chaque ressource est limitée à 64 étiquettes. Les clés doivent être conformes à l'expression régulière: [a-zA-Z][a-zA-Z0-9_-]{0,62} Les valeurs doivent être conformes à l'expression régulière: [a-zA-Z0-9_-]{0,63} Les clés et les valeurs sont en outre limitées à 128 octets.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
requireApproval

boolean

Facultatif. Indique si Target nécessite une approbation.
createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le Target a été créé.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour de Target.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
etag

string

Facultatif. Cette somme de contrôle est calculée par le serveur en fonction de la valeur d'autres champs. Elle peut être envoyée lors des requêtes de mise à jour et de suppression pour s'assurer que le client dispose d'une valeur à jour avant de poursuivre.
executionConfigs[]

object (ExecutionConfig)

Configurations pour toutes les exécutions associées à ce Target. Chaque valeur ExecutionEnvironmentUsage ne peut être utilisée que dans une seule configuration. Utiliser la même valeur plusieurs fois est une erreur. Lorsqu'une ou plusieurs configurations sont spécifiées, elles doivent inclure les valeurs ExecutionEnvironmentUsage RENDER et DEPLOY. Si aucune configuration n'est spécifiée, l'exécution utilise la valeur par défaut spécifiée dans DefaultPool.
Champ d'union deployment_target. Destination à laquelle la configuration Skaffold est appliquée lors d'un déploiement. deployment_target ne peut être qu'un des éléments suivants :
gkeCluster

object (GKECluster)

Informations spécifiant un cluster GKE.
cluster

object (GkeCluster)

Informations spécifiant un cluster GKE.
gke

object (GkeCluster)

Informations spécifiant un cluster GKE.

GKECluster

Informations spécifiant un cluster GKE.

Représentation JSON 
{
  "project": string,
  "cluster": string,
  "location": string
}
Champs
project

string

Projet dans lequel se trouve le cluster.
cluster

string

Nom du cluster.
location

string

Emplacement du cluster.

GkeCluster

Informations spécifiant un cluster GKE.

Représentation JSON 
{
  "cluster": string
}
Champs
cluster

string

Informations spécifiant un cluster GKE. Le format est "projects/{projectId}/locations/{locationId}/clusters/{cluster_id}".

ExecutionConfig

Configuration de l'environnement à utiliser lors de l'appel de Skaffold.

Représentation JSON 
{
  "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.
}
Champs
usages[]

enum (ExecutionEnvironmentUsage)

Obligatoire. Utilisations dans lesquelles cette configuration doit être appliquée.
Champ d'union execution_environment. Détails de l'environnement execution_environment ne peut être qu'un des éléments suivants :
defaultPool

object (DefaultPool)

Facultatif. Utilisez le pool Cloud Build par défaut.
privatePool

object (PrivatePool)

Facultatif. Utilisez un pool Cloud Build privé.

ExecutionEnvironmentUsage

Utilisations possibles de cette configuration.

Enums
EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
RENDER À utiliser pour le rendu.
DEPLOY À utiliser pour le déploiement et les hooks de déploiement.

DefaultPool

Exécution à l'aide du pool Cloud Build par défaut

Représentation JSON 
{
  "serviceAccount": string,
  "artifactStorage": string
}
Champs
serviceAccount

string

Facultatif. Compte de service Google à utiliser pour l'exécution. S'il n'est pas spécifié, le compte de service d'exécution du projet (-compute@developer.gserviceaccount.com) sera utilisé.
artifactStorage

string

Facultatif. Emplacement Cloud Storage où les résultats de l'exécution doivent être stockés. Il peut s'agir d'un bucket ("gs://my-bucket") ou d'un chemin d'accès à l'intérieur d'un bucket ("gs://my-bucket/my-dir"). S'il n'est pas spécifié, un bucket par défaut situé dans la même région sera utilisé.

PrivatePool

Exécution à l'aide d'un pool Cloud Build privé

Représentation JSON 
{
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string
}
Champs
workerPool

string

Obligatoire. Nom de ressource du pool de nœuds de calcul Cloud Build à utiliser. Il a le format suivant : projects/{project}/locations/{location}/workerPools/{pool}.
serviceAccount

string

Facultatif. Compte de service Google à utiliser pour l'exécution. S'il n'est pas spécifié, le compte de service d'exécution du projet (-compute@developer.gserviceaccount.com) sera utilisé.
artifactStorage

string

Facultatif. Emplacement Cloud Storage où les résultats de l'exécution doivent être stockés. Il peut s'agir d'un bucket ("gs://my-bucket") ou d'un chemin d'accès à l'intérieur d'un bucket ("gs://my-bucket/my-dir"). S'il n'est pas spécifié, un bucket par défaut situé dans la même région sera utilisé.

Méthodes

create

 Crée une cible dans un projet et un emplacement donnés.

delete

 Supprime une seule cible partagée.

get

 Récupère les détails d'une seule cible partagée.

list

 Répertorie les cibles dans un projet et un emplacement donnés.

patch

 Met à jour les paramètres d'une cible unique partagée.