REST Resource: projects.locations.rollouts

Ressource : Rollout

Représente une seule exécution de déploiement et ses résultats

Représentation JSON 
{
  "name": string,
  "release": string,
  "startTime": string,
  "endTime": string,
  "state": enum (RolloutState),
  "stateMessage": string,
  "stateTransitionTime": string,
  "rootRollout": string,
  "parentRollout": string,
  "rolloutOrchestrationStrategy": string,
  "unitFilter": string,
  "rolloutKind": string,
  "stats": {
    object (RolloutStats)
  },
  "control": {
    object (RolloutControl)
  },
  "effectiveUnitFilter": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string
}
Champs
name

string

Identifiant. Nom de la ressource (URI complet de la ressource) suivant le schéma de dénomination standard :

"projects/{project}/locations/{location}/rollout/{rolloutId}"
release

string

Facultatif. Immuable. Nom de la version déployée sur les unités cibles. Obligatoire si aucun autre type de version n'est spécifié.
startTime

string (Timestamp format)

Facultatif. Uniquement en sortie. Heure de début de l'exécution du déploiement. Ce champ sera vide si le déploiement n'a pas encore commencé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Facultatif. Uniquement en sortie. Heure à laquelle le déploiement s'est terminé (qu'il ait réussi, échoué ou été annulé). Sera vide si le déploiement n'est pas encore terminé. Une fois la fonctionnalité définie, le déploiement est dans un état final et tous les résultats sont définitifs.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
state

enum (RolloutState)

Uniquement en sortie. État actuel du déploiement.
stateMessage

string

Uniquement en sortie. Message lisible par l'humain indiquant des détails sur la dernière transition d'état.
stateTransitionTime

string (Timestamp format)

Facultatif. Uniquement en sortie. Heure à laquelle le déploiement est passé à son état actuel.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
rootRollout

string

Facultatif. Uniquement en sortie. Déploiement racine dont ce déploiement est issu. Nom de la ressource (URI complet de la ressource) suivant le schéma de dénomination standard :

"projects/{project}/locations/{location}/rollouts/{rolloutId}"
parentRollout

string

Facultatif. Uniquement en sortie. Déploiement parent direct à partir duquel ce déploiement est issu. Nom de la ressource (URI complet de la ressource) suivant le schéma de dénomination standard :

"projects/{project}/locations/{location}/rollouts/{rolloutId}"
rolloutOrchestrationStrategy

string

Facultatif. Stratégie utilisée pour exécuter ce déploiement. Cette stratégie remplacera celle spécifiée dans RolloutKind. Si aucune stratégie n'est spécifiée lors de la création, celle de RolloutKind est utilisée.

Deux stratégies de valeurs sont acceptées et utilisées pour le contrôle : "Google.Cloud.Simple.AllAtOnce" et "Google.Cloud.Simple.OneLocationAtATime".

Un déploiement avec l'une de ces stratégies simples sera déployé dans tous les emplacements définis dans les emplacements SaaS du genre d'unité ciblé.
unitFilter

string

Facultatif. Chaîne de filtre au format CEL(https://github.com/google/cel-spec) par rapport à Unit. Le filtre sera appliqué pour déterminer la population d'unités éligibles. Ce filtre ne peut que réduire le champ d'application du déploiement, et non l'étendre. Si aucune valeur n'est fournie, le unitFilter de RolloutKind est utilisé.
rolloutKind

string

Facultatif. Immuable. Nom du RolloutKind dont ce déploiement est issu et auquel il se conforme.
stats

object (RolloutStats)

Facultatif. Uniquement en sortie. Détails sur la progression du déploiement.
control

object (RolloutControl)

Facultatif. Modification demandée pour l'exécution de ce déploiement. L'action RolloutControl.action par défaut est ROLLOUT_ACTION_RUN, ce qui signifie que le déploiement sera exécuté jusqu'à la fin en passant par tous les états de déploiement naturels (par exemple, RUNNING → SUCCEEDED ou RUNNING → FAILED). Les demandes ne peuvent être effectuées que lorsque le déploiement n'est pas dans un état final.
effectiveUnitFilter

string

Facultatif. Uniquement en sortie. Sortie d'un instantané du filtre d'unité efficace à l'heure de début du déploiement uniquement. Contient une expression CEL(https://github.com/google/cel-spec) composée d'une conjonction de Rollout.unit_filter et RolloutKind.unit_filter. Ce champ capture le filtre appliqué par le déploiement pour déterminer la population d'unités. Si le unitFilter du RolloutKind associé est modifié après le début du déploiement, il ne sera pas mis à jour ici.
labels

map (key: string, value: string)

Facultatif. Libellés de la ressource, qui peuvent être utilisés pour la catégorisation. Ils sont semblables aux libellés de ressources Kubernetes.

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

map (key: string, value: string)

Facultatif. Les annotations sont un mappage clé-valeur non structuré stocké avec une ressource. Elles peuvent être définies par des outils externes pour stocker et récupérer des métadonnées arbitraires. Elles ne peuvent pas faire l'objet de requêtes et doivent être conservées lors de la modification d'objets.

Pour en savoir plus, consultez https://kubernetes.io/docs/user-guide/annotations.

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

string

Uniquement en sortie. Identifiant unique de la ressource. L'UID est unique dans le temps et l'espace pour cette ressource dans le cadre du service. Il est habituellement généré par le serveur lors de la création réussie d'une ressource et ne doit pas être modifié. L'UID permet d'identifier de manière unique les ressources avec réutilisation du nom. Il doit être un UUID4.
etag

string

Uniquement en sortie. Valeur opaque qui identifie de manière unique la version ou la génération d'une ressource. Cet identifiant permet de confirmer que le client et le serveur sont d'accord sur l'ordre d'écriture d'une ressource.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la création de la ressource.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de la ressource. Toute modification de la ressource par les utilisateurs doit actualiser cette valeur. Les modifications d'une ressource par le service doivent actualiser cette valeur.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
deleteTime

string (Timestamp format)

Uniquement en sortie. Code temporel indiquant le moment où la ressource a été marquée pour suppression (la suppression est une opération asynchrone).

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

RolloutState

État actuel du déploiement.

Enums
ROLLOUT_STATE_UNSPECIFIED État non spécifié.
ROLLOUT_STATE_RUNNING Le déploiement est en cours.
ROLLOUT_STATE_PAUSED Le déploiement a été suspendu.
ROLLOUT_STATE_SUCCEEDED Le déploiement a bien été effectué.
ROLLOUT_STATE_FAILED Échec du déploiement.
ROLLOUT_STATE_CANCELLED Le déploiement a été annulé.
ROLLOUT_STATE_WAITING Le déploiement attend qu'une condition soit remplie avant de commencer.
ROLLOUT_STATE_CANCELLING Le déploiement est en cours d'annulation.
ROLLOUT_STATE_RESUMING Le déploiement est en cours de reprise.
ROLLOUT_STATE_PAUSING Le déploiement est suspendu.

RolloutStats

RolloutStats contient des informations sur la progression d'un déploiement.

Représentation JSON 
{
  "operationsByState": [
    {
      object (Aggregate)
    }
  ]
}
Champs
operationsByState[]

object (Aggregate)

Facultatif. Uniquement en sortie. Liste non triée. Répartition de la progression des opérations déclenchées par le déploiement. Indique le nombre d'opérations par état. Cela permet de déterminer le nombre d'unités qui ont été mises à jour ou qui doivent l'être.

Il n'y aura qu'une seule entrée par groupe. Les valeurs possibles pour les groupes d'opérations sont les suivantes : "SCHEDULED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED" et "CANCELLED".

Agréger

Représente l'agrégation d'un ensemble de populations d'enregistrements similaires par un certain groupe. Par exemple, une collection de nombres d'unités peut être agrégée et regroupée par état.

Représentation JSON 
{
  "group": string,
  "count": integer
}
Champs
group

string

Obligatoire. Groupe selon lequel agréger les données.
count

integer

Obligatoire. Nombre d'enregistrements dans le groupe.

RolloutControl

RolloutControl permet de demander une modification de l'exécution d'un déploiement en le mettant en pause ou en l'annulant.

Représentation JSON 
{
  "action": enum (RolloutAction),

  // Union field action_params can be only one of the following:
  "runParams": {
    object (RunRolloutActionParams)
  }
  // End of list of possible types for union field action_params.
}
Champs
action

enum (RolloutAction)

Obligatoire. Action à effectuer sur le déploiement. Le comportement par défaut consiste à exécuter le déploiement jusqu'à ce qu'il atteigne naturellement un état final.
Champ d'union action_params. Paramètre de l'action. Le paramètre doit correspondre à l'action. Par exemple, action=RUN ne peut définir que run_params ou omettre tous les paramètres. Il s'agit d'une erreur de définir un paramètre qui ne s'applique pas à l'action. action_params ne peut être qu'un des éléments suivants :
runParams

object (RunRolloutActionParams)

Facultatif. Paramètres de l'action RUN. Une erreur se produit si vous spécifiez cette valeur alors que RolloutAction n'est pas défini sur RUN. Par défaut, le déploiement relancera les opérations ayant échoué lorsqu'il sera repris.

RunRolloutActionParams

Paramètres de l'action RUN qui contrôlent le comportement du déploiement lorsqu'il est repris à partir d'un état PAUSED.

Représentation JSON 
{
  "retryFailedOperations": boolean
}
Champs
retryFailedOperations

boolean

Obligatoire. Si la valeur est "true", le déploiement réessaiera les opérations ayant échoué lorsqu'il sera repris. Cela ne s'applique que si l'état actuel du déploiement est "PAUSED" et que l'action demandée est "RUN".

RolloutAction

RolloutAction indique l'action à effectuer sur le déploiement.

Enums
ROLLOUT_ACTION_UNSPECIFIED Si aucune action n'est spécifiée, l'action RUN est appliquée par défaut.
ROLLOUT_ACTION_RUN Exécutez le déploiement jusqu'à ce qu'il atteigne naturellement un état final. Un déploiement dont l'exécution a été demandée passera par tous les états de déploiement naturels (par exemple, RUNNING → SUCCEEDED ou RUNNING → FAILED). Si des erreurs pouvant être corrigées se produisent lors du déploiement, celui-ci est mis en pause par défaut. Vous pouvez le reprendre en demandant à nouveau cette action RUN.
ROLLOUT_ACTION_PAUSE Mettre en veille le déploiement jusqu'à ce qu'il soit réactivé (c'est-à-dire que l'exécution est demandée).
ROLLOUT_ACTION_CANCEL Annulez définitivement le déploiement.

Méthodes

create

 Créez un déploiement.

delete

 Supprimez une seule mise en service.

get

 Récupérez un déploiement unique.

list

 Récupérez une collection de déploiements.

patch

 Mettez à jour un seul déploiement.