REST Resource: projects.locations.deliveryPipelines.automationRuns

Ressource: AutomationRun

Une ressource AutomationRun dans l'API Cloud Deploy.

Un AutomationRun représente une instance d'exécution d'une règle d'automatisation.

Représentation JSON
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "serviceAccount": string,
  "automationSnapshot": {
    object (Automation)
  },
  "targetId": string,
  "state": enum (State),
  "stateDescription": string,
  "expireTime": string,
  "ruleId": string,
  "automationId": string,
  "waitUntilTime": string,

  // Union field operation can be only one of the following:
  "promoteReleaseOperation": {
    object (PromoteReleaseOperation)
  },
  "advanceRolloutOperation": {
    object (AdvanceRolloutOperation)
  },
  "repairRolloutOperation": {
    object (RepairRolloutOperation)
  }
  // End of list of possible types for union field operation.
}
Champs
name

string

Uniquement en sortie. Nom du AutomationRun. Le format est le suivant : projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/automationRuns/{automationRun}.

createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le AutomationRun 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 à laquelle l'automatisationRun a été mise à jour.

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

Uniquement en sortie. Etag faible de la ressource AutomationRun. 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.

serviceAccount

string

Uniquement en sortie. Adresse e-mail du compte de service IAM géré par l'utilisateur qui effectue les opérations sur les ressources Cloud Deploy.

automationSnapshot

object (Automation)

Uniquement en sortie. Instantané de l'automatisation prise au moment de la création de l'AutomationRun.

targetId

string

Uniquement en sortie. ID de la cible qui représente l'étape de promotion qui lance le AutomationRun. La valeur de ce champ est le dernier segment du nom d'une cible.

state

enum (State)

Uniquement en sortie. État actuel de AutomationRun.

stateDescription

string

Uniquement en sortie. Explique l'état actuel de AutomationRun. Présent uniquement lorsqu'une explication est nécessaire.

expireTime

string (Timestamp format)

Uniquement en sortie. Heure d'expiration de AutomationRun. Une AutomationRun expire 14 jours après sa date de création.

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

ruleId

string

Uniquement en sortie. ID de la règle d'automatisation qui a lancé l'opération.

automationId

string

Uniquement en sortie. ID de l'automatisation qui a lancé l'opération.

waitUntilTime

string (Timestamp format)

Uniquement en sortie. Heure au plus tôt pour la reprise du AutomationRun. Le temps d'attente est configuré par wait dans la règle d'automatisation.

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

Champ d'union operation. Opération effectuée par AutomationRun. La operation ne peut être qu'un des éléments suivants :
promoteReleaseOperation

object (PromoteReleaseOperation)

Uniquement en sortie. Passe une version vers une "Target" spécifiée.

advanceRolloutOperation

object (AdvanceRolloutOperation)

Uniquement en sortie. Passe un déploiement à la phase suivante.

repairRolloutOperation

object (RepairRolloutOperation)

Uniquement en sortie. Répare un déploiement ayant échoué.

État

État valide d'un AutomationRun.

Enums
STATE_UNSPECIFIED L'état de AutomationRun n'est pas spécifié.
SUCCEEDED AutomationRun a réussi.
CANCELLED AutomationRun a été annulé.
FAILED Échec de AutomationRun.
IN_PROGRESS Le AutomationRun est en cours.
PENDING Le AutomationRun est en attente.
ABORTED Le AutomationRun a été annulé.

PromoteReleaseOperation

Contient les informations d'une opération automatisée de promotion/publication.

Représentation JSON
{
  "targetId": string,
  "wait": string,
  "rollout": string,
  "phase": string
}
Champs
targetId

string

Uniquement en sortie. ID de la cible qui représente l'étape de promotion à laquelle la version sera promue. La valeur de ce champ est le dernier segment du nom d'une cible.

wait

string (Duration format)

Uniquement en sortie. Durée de suspension de l'opération.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

rollout

string

Uniquement en sortie. Nom du déploiement qui lance le AutomationRun.

phase

string

Uniquement en sortie. Phase de début du déploiement créée par cette opération.

AdvanceRolloutOperation

Contient les informations d'une opération de déploiement anticipé automatisée.

Représentation JSON
{
  "sourcePhase": string,
  "wait": string,
  "rollout": string,
  "destinationPhase": string
}
Champs
sourcePhase

string

Uniquement en sortie. Phase d'un déploiement à l'origine de l'opération.

wait

string (Duration format)

Uniquement en sortie. Durée de suspension de l'opération.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

rollout

string

Uniquement en sortie. Nom du déploiement qui lance le AutomationRun.

destinationPhase

string

Uniquement en sortie. Phase à laquelle le déploiement sera avancé.

RepairRolloutOperation

Contient les informations d'une opération repair rollout automatisée.

Représentation JSON
{
  "rollout": string,
  "currentRepairModeIndex": string,
  "repairPhases": [
    {
      object (RepairPhase)
    }
  ],
  "phaseId": string,
  "jobId": string
}
Champs
rollout

string

Uniquement en sortie. Nom du déploiement qui lance le AutomationRun.

currentRepairModeIndex

string (int64 format)

Uniquement en sortie. Index de l'action de réparation en cours dans la séquence de réparation.

repairPhases[]

object (RepairPhase)

Uniquement en sortie. Les registres des tentatives de réparation Chaque phase de réparation peut comporter plusieurs tentatives ou un seul rollback.

phaseId

string

Uniquement en sortie. ID de la phase qui inclut la tâche en cours de réparation.

jobId

string

Uniquement en sortie. ID de la tâche à réparer.

RepairPhase

réparationPhase suit les tentatives de réparation effectuées pour chaque RepairMode spécifié dans la ressource Automation.

Représentation JSON
{

  // Union field repair_phase can be only one of the following:
  "retry": {
    object (RetryPhase)
  },
  "rollback": {
    object (RollbackAttempt)
  }
  // End of list of possible types for union field repair_phase.
}
Champs

Champ d'union repair_phase.

repair_phase ne peut être qu'un des éléments suivants :

retry

object (RetryPhase)

Uniquement en sortie. Enregistrements des nouvelles tentatives de réparation pour le mode de nouvelle tentative de réparation.

rollback

object (RollbackAttempt)

Uniquement en sortie. Tentative de rollback pour le mode de réparation de rollback .

RetryPhase

RéessayerPhase contient les tentatives de nouvelle tentative et les métadonnées permettant de lancer une nouvelle tentative.

Représentation JSON
{
  "totalAttempts": string,
  "backoffMode": enum (BackoffMode),
  "phaseId": string,
  "jobId": string,
  "attempts": [
    {
      object (RetryAttempt)
    }
  ]
}
Champs
totalAttempts

string (int64 format)

Uniquement en sortie. Nombre de tentatives effectuées.

backoffMode

enum (BackoffMode)

Uniquement en sortie. Modèle de calcul du temps d'attente de la nouvelle tentative.

phaseId
(deprecated)

string

Uniquement en sortie. ID de la phase qui inclut la tâche en cours de nouvelle tentative.

jobId
(deprecated)

string

Uniquement en sortie. ID du job à réessayer.

attempts[]

object (RetryAttempt)

Uniquement en sortie. Détail d'une nouvelle tentative.

RetryAttempt

La requête "Réessayer" représente une nouvelle tentative d'exécution de la tâche Cloud Deploy ayant échoué.

Représentation JSON
{
  "attempt": string,
  "wait": string,
  "state": enum (RepairState),
  "stateDesc": string
}
Champs
attempt

string (int64 format)

Uniquement en sortie. Index de cette nouvelle tentative.

wait

string (Duration format)

Uniquement en sortie. Durée de suspension de l'opération.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

state

enum (RepairState)

Uniquement en sortie. État valide de cette nouvelle tentative.

stateDesc

string

Uniquement en sortie. Description de l'état de la nouvelle tentative.

RepairState

État valide d'une tentative de réparation.

Enums
REPAIR_STATE_UNSPECIFIED L'état de repair n'est pas spécifié.
REPAIR_STATE_SUCCEEDED L'action repair a bien été effectuée.
REPAIR_STATE_CANCELLED L'action repair a été annulée.
REPAIR_STATE_FAILED Échec de l'action repair.
REPAIR_STATE_IN_PROGRESS L'action repair est en cours.
REPAIR_STATE_PENDING L'action repair est en attente.
REPAIR_STATE_SKIPPED L'action repair a été ignorée.
REPAIR_STATE_ABORTED L'action repair a été annulée.

RollbackAttempt

Une tentative de rollback représente une action de rollback d'une cible Cloud Deploy.

Représentation JSON
{
  "destinationPhase": string,
  "rolloutId": string,
  "state": enum (RepairState),
  "stateDesc": string
}
Champs
destinationPhase

string

Uniquement en sortie. Phase à laquelle le déploiement sera annulé.

rolloutId

string

Uniquement en sortie. ID du Rollout de rollback à créer.

state

enum (RepairState)

Uniquement en sortie. État valide de cette action de rollback.

stateDesc

string

Uniquement en sortie. Description de l'état du rollback.

Méthodes

cancel

Annule un AutomationRun.

get

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

list

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