REST Resource: projects.locations.customTargetTypes

Ressource: CustomTargetType

Une ressource CustomTargetType dans l'API Cloud Deploy

Un CustomTargetType définit un type de cible personnalisée qui peut être référencé dans un Target afin de faciliter le déploiement sur d'autres systèmes que les environnements d'exécution compatibles.

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

string

Facultatif. Nom du CustomTargetType. Le format est le suivant : projects/{project}/locations/{location}/customTargetTypes/{customTargetType}. Le composant customTargetType doit correspondre à [a-z]([a-z0-9-]{0,61}[a-z0-9])?
customTargetTypeId

string

Uniquement en sortie. ID de ressource de CustomTargetType.
uid

string

Uniquement en sortie. Identifiant unique du CustomTargetType.
description

string

Facultatif. Description de CustomTargetType. 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 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 Cloud Deploy. Les étiquettes doivent respecter les contraintes suivantes:

  • Les clés et les valeurs ne peuvent contenir que des lettres minuscules, des chiffres, des traits de soulignement et des tirets.
  • Tous les caractères doivent être encodés au format UTF-8. Les caractères internationaux sont acceptés.
  • Les clés doivent commencer par une lettre minuscule ou un caractère international.
  • Chaque ressource est limitée à un maximum de 64 libellés.

Les clés et les valeurs doivent également avoir une taille inférieure ou égale à 128 octets.

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

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le CustomTargetType 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 CustomTargetType.

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.
Champ d'union definition. Définit le moteur de rendu et le déployeur CustomTargetType. La definition ne peut être qu'un des éléments suivants :
customActions

object (CustomTargetSkaffoldActions)

Configure le rendu et le déploiement pour CustomTargetType à l'aide d'actions personnalisées Skaffold.

CustomTargetSkaffoldActions

CustomTargetSkaffoldActions représente la configuration CustomTargetType à l'aide d'actions personnalisées Skaffold.

Représentation JSON 
{
  "renderAction": string,
  "deployAction": string,
  "includeSkaffoldModules": [
    {
      object (SkaffoldModules)
    }
  ]
}
Champs
renderAction

string

Facultatif. Action personnalisée Skaffold responsable des opérations de rendu. S'il n'est pas fourni, Cloud Deploy effectue les opérations de rendu via skaffold render.
deployAction

string

Obligatoire. Action personnalisée Skaffold responsable des opérations de déploiement.
includeSkaffoldModules[]

object (SkaffoldModules)

Facultatif. Liste des modules Skaffold que Cloud Deploy intégrera dans la configuration Skaffold si nécessaire avant d'effectuer le diagnostic.

SkaffoldModules

les modules de configuration Skaffold et leur source distante ;

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

string

Facultatif. Modules de configuration Skaffold à utiliser à partir de la source spécifiée.
Champ d'union source. Source contenant les modules de configuration Skaffold. source ne peut être qu'un des éléments suivants :
git

object (SkaffoldGitSource)

Dépôt Git distant contenant les modules de configuration Skaffold
googleCloudStorage

object (SkaffoldGCSSource)

Bucket Cloud Storage contenant les modules de configuration Skaffold.
googleCloudBuildRepo

object (SkaffoldGCBRepoSource)

Dépôt Cloud Build V2 contenant les modules de configuration Skaffold.

SkaffoldGitSource

Dépôt Git contenant des modules de configuration Skaffold.

Représentation JSON 
{
  "repo": string,
  "path": string,
  "ref": string
}
Champs
repo

string

Obligatoire. Dépôt Git à partir duquel le package doit être cloné.
path

string

Facultatif. Chemin d'accès relatif de la racine du dépôt au fichier Skaffold.
ref

string

Facultatif. Branche ou tag Git à utiliser lors du clonage du dépôt.

SkaffoldGCSSource

Bucket Cloud Storage contenant des modules de configuration Skaffold.

Représentation JSON 
{
  "source": string,
  "path": string
}
Champs
source

string

Obligatoire. Chemins d'accès sources Cloud Storage à copier de manière récursive. Par exemple, si vous spécifiez "gs://my-bucket/dir/configs/*", Skaffold copiera tous les fichiers du répertoire "dir/configs" dans le bucket "my-bucket".
path

string

Facultatif. Chemin d'accès relatif de la source au fichier Skaffold.

SkaffoldGCBRepoSource

Dépôt Cloud Build V2 contenant des configurations Skaffold.

Représentation JSON 
{
  "repository": string,
  "path": string,
  "ref": string
}
Champs
repository

string

Obligatoire. Nom du dépôt Cloud Build V2. Le format est projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}.
path

string

Facultatif. Chemin d'accès relatif de la racine du dépôt au fichier de configuration Skaffold.
ref

string

Facultatif. Branche ou tag à utiliser lors du clonage du dépôt.

Méthodes

create

 Crée un CustomTargetType dans un projet et un emplacement donnés.

delete

 Supprime un seul CustomTargetType.

get

 Récupère les détails d'un seul CustomTargetType.

getIamPolicy

 Récupère la stratégie de contrôle d'accès d'une ressource.

list

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

patch

 Met à jour un seul CustomTargetType.

setIamPolicy

 Définit la stratégie de contrôle d'accès de la ressource spécifiée.