REST Resource: projects.locations.deliveryPipelines.releases.rollouts.jobRuns

Ressource: JobRun

Une ressource JobRun dans l'API Cloud Deploy

Un JobRun contient les informations d'une seule évaluation de tâche Rollout.

Représentation JSON 
{
  "name": string,
  "uid": string,
  "phaseId": string,
  "jobId": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "state": enum (State),
  "etag": string,

  // Union field job_run can be only one of the following:
  "deployJobRun": {
    object (DeployJobRun)
  },
  "verifyJobRun": {
    object (VerifyJobRun)
  },
  "predeployJobRun": {
    object (PredeployJobRun)
  },
  "postdeployJobRun": {
    object (PostdeployJobRun)
  },
  "createChildRolloutJobRun": {
    object (CreateChildRolloutJobRun)
  },
  "advanceChildRolloutJobRun": {
    object (AdvanceChildRolloutJobRun)
  }
  // End of list of possible types for union field job_run.
}
Champs
name

string

Facultatif. Nom du JobRun. Le format est le suivant : projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.
uid

string

Uniquement en sortie. Identifiant unique du JobRun.
phaseId

string

Uniquement en sortie. ID de la phase Rollout à laquelle appartient ce JobRun.
jobId

string

Uniquement en sortie. ID de la tâche Rollout à laquelle ce JobRun correspond.
createTime

string (Timestamp format)

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

string (Timestamp format)

Uniquement en sortie. Heure à laquelle JobRun a démarré.

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

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la JobRun s'est terminée.

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

enum (State)

Uniquement en sortie. État actuel de JobRun.
etag

string

Uniquement en sortie. 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 job_run. Le type JobRun et les informations le concernant La job_run ne peut être qu'un des éléments suivants :
deployJobRun

object (DeployJobRun)

Uniquement en sortie. Informations spécifiques à un JobRun de déploiement.
verifyJobRun

object (VerifyJobRun)

Uniquement en sortie. Informations spécifiques à un JobRun de validation.
predeployJobRun

object (PredeployJobRun)

Uniquement en sortie. Informations spécifiques à un JobRun de prédéploiement.
postdeployJobRun

object (PostdeployJobRun)

Uniquement en sortie. Informations spécifiques à un JobRun post-déploiement.
createChildRolloutJobRun

object (CreateChildRolloutJobRun)

Uniquement en sortie. Informations spécifiques à un JobRun createChildRollout.
advanceChildRolloutJobRun

object (AdvanceChildRolloutJobRun)

Uniquement en sortie. Informations spécifiques à un JobRun progressChildRollout

État

États valides d'une JobRun.

Enums
STATE_UNSPECIFIED L'état de JobRun n'est pas spécifié.
IN_PROGRESS Le JobRun est en cours.
SUCCEEDED JobRun a réussi.
FAILED Échec de JobRun.
TERMINATING JobRun est en cours d'arrêt.
TERMINATED JobRun a été arrêté.

DeployJobRun

DeployJobRun contient des informations spécifiques à un JobRun de déploiement.

Représentation JSON 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string,
  "metadata": {
    object (DeployJobRunMetadata)
  },
  "artifact": {
    object (DeployArtifact)
  }
}
Champs
build

string

Uniquement en sortie. Nom de ressource de l'objet Build Cloud Build utilisé pour le déploiement. Le format est le suivant : projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Uniquement en sortie. Motif de l'échec du déploiement. Ce paramètre n'est jamais spécifié tant que le déploiement est en cours ou s'il a réussi.
failureMessage

string

Uniquement en sortie. Informations supplémentaires sur l'échec du déploiement, si disponibles.
metadata

object (DeployJobRunMetadata)

Uniquement en sortie. Métadonnées contenant des informations sur l'exécution du job de déploiement.
artifact

object (DeployArtifact)

Uniquement en sortie. Artefact d'exécution d'un job de déploiement, s'il est disponible.

FailureCause

Échecs de déploiement connus.

Enums
FAILURE_CAUSE_UNSPECIFIED Aucun motif d'échec n'est spécifié.
CLOUD_BUILD_UNAVAILABLE Cloud Build n'est pas disponible, soit parce qu'il n'est pas activé, soit parce que Cloud Deploy ne dispose pas des autorisations nécessaires. Consultez la section Autorisation requise.
EXECUTION_FAILED L'opération de déploiement ne s'est pas terminée correctement. Consultez les journaux Cloud Build.
DEADLINE_EXCEEDED L'exécution du job de déploiement ne s'est pas terminée dans le temps imparti.
MISSING_RESOURCES_FOR_CANARY Il manquait des ressources dans l'environnement d'exécution requis pour un déploiement Canary. Pour en savoir plus, consultez les journaux Cloud Build.
CLOUD_BUILD_REQUEST_FAILED Cloud Build n'a pas pu traiter la requête de Cloud Deploy. Pour en savoir plus, consultez la section "failMessage".
DEPLOY_FEATURE_NOT_SUPPORTED Une fonctionnalité configurée pour l'opération de déploiement n'est pas compatible.

DeployJobRunMetadata

DeployJobRunMetadata présente à l'utilisateur les informations associées à un DeployJobRun.

Représentation JSON 
{
  "cloudRun": {
    object (CloudRunMetadata)
  },
  "customTarget": {
    object (CustomTargetDeployMetadata)
  },
  "custom": {
    object (CustomMetadata)
  }
}
Champs
cloudRun

object (CloudRunMetadata)

Uniquement en sortie. Nom du service Cloud Run associé à un DeployJobRun.
customTarget

object (CustomTargetDeployMetadata)

Uniquement en sortie. Métadonnées de cible personnalisée associées à un DeployJobRun.
custom

object (CustomMetadata)

Uniquement en sortie. Métadonnées personnalisées fournies par l'opération de déploiement définie par l'utilisateur.

CustomTargetDeployMetadata

CustomTargetDeployMetadata contient des informations provenant d'une opération de déploiement de cible personnalisée.

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

string

Uniquement en sortie. Message d'omission fourni dans les résultats d'une opération de déploiement personnalisée.

DeployArtifact

Artefacts produits par une opération de déploiement.

Représentation JSON 
{
  "artifactUri": string,
  "manifestPaths": [
    string
  ]
}
Champs
artifactUri

string

Uniquement en sortie. URI d'un répertoire contenant les artefacts. Tous les chemins d'accès sont relatifs à cet emplacement.
manifestPaths[]

string

Uniquement en sortie. Chemins d'accès aux fichiers manifestes appliqués lors de l'opération de déploiement par rapport à l'URI.

VerifyJobRun

VerifyJobRun contient des informations spécifiques à un JobRun de validation.

Représentation JSON 
{
  "build": string,
  "artifactUri": string,
  "eventLogPath": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Champs
build

string

Uniquement en sortie. Nom de ressource de l'objet Build Cloud Build utilisé pour la vérification. Le format est le suivant : projects/{project}/locations/{location}/builds/{build}.
artifactUri

string

Uniquement en sortie. URI d'un répertoire contenant les artefacts de vérification. Ce dossier contient le journal des événements Skaffold.
eventLogPath

string

Uniquement en sortie. Chemin d'accès au fichier journal des événements Skaffold par rapport à l'URI de l'artefact.
failureCause

enum (FailureCause)

Uniquement en sortie. Motif de l'échec de la validation. Ce paramètre n'est toujours pas spécifié tant que la validation est en cours ou si elle a abouti.
failureMessage

string

Uniquement en sortie. Informations supplémentaires sur l'échec de la validation, le cas échéant.

FailureCause

Échecs de vérification connus.

Enums
FAILURE_CAUSE_UNSPECIFIED Aucun motif d'échec n'est spécifié.
CLOUD_BUILD_UNAVAILABLE Cloud Build n'est pas disponible, soit parce qu'il n'est pas activé, soit parce que Cloud Deploy ne dispose pas des autorisations nécessaires. Consultez Autorisation requise.
EXECUTION_FAILED L'opération de vérification n'a pas abouti. Vérifiez les journaux Cloud Build.
DEADLINE_EXCEEDED Le job de vérification n'a pas été exécuté dans le temps imparti.
VERIFICATION_CONFIG_NOT_FOUND Aucune configuration de vérification Skaffold n'a été trouvée.
CLOUD_BUILD_REQUEST_FAILED Cloud Build n'a pas pu traiter la requête de Cloud Deploy. Pour en savoir plus, consultez la section "failMessage".

PredeployJobRun

PredeployJobRun contient des informations spécifiques à un JobRun de prédéploiement.

Représentation JSON 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Champs
build

string

Uniquement en sortie. Nom de ressource de l'objet Build Cloud Build utilisé pour exécuter les actions personnalisées associées au job de prédéploiement. Le format est le suivant : projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Uniquement en sortie. Motif de l'échec du prédéploiement. Ce paramètre n'est jamais spécifié tant que le prédéploiement est en cours ou s'il a réussi.
failureMessage

string

Uniquement en sortie. Informations supplémentaires sur l'échec du prédéploiement, si disponibles

FailureCause

Échecs connus du prédéploiement.

Enums
FAILURE_CAUSE_UNSPECIFIED Aucun motif d'échec n'est spécifié.
CLOUD_BUILD_UNAVAILABLE Cloud Build n'est pas disponible, soit parce qu'il n'est pas activé, soit parce que Cloud Deploy ne dispose pas des autorisations nécessaires. Consultez Autorisation requise.
EXECUTION_FAILED L'opération de prédéploiement ne s'est pas terminée correctement. Consultez les journaux Cloud Build.
DEADLINE_EXCEEDED L'exécution du job de prédéploiement ne s'est pas terminée dans le temps imparti.
CLOUD_BUILD_REQUEST_FAILED Cloud Build n'a pas pu traiter la requête de Cloud Deploy. Pour en savoir plus, consultez la section "failMessage".

PostdeployJobRun

PostdeployJobRun contient des informations spécifiques à un JobRun de post-déploiement.

Représentation JSON 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Champs
build

string

Uniquement en sortie. Nom de ressource de l'objet Build Cloud Build utilisé pour exécuter les actions personnalisées associées au job de postdéploiement. Le format est le suivant : projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Uniquement en sortie. Motif de l'échec du postdéploiement. Ce paramètre n'est toujours pas spécifié tant que le post-déploiement est en cours ou s'il a réussi.
failureMessage

string

Uniquement en sortie. Informations supplémentaires sur l'échec du post-déploiement, si disponibles.

FailureCause

Échecs de post-déploiement connus

Enums
FAILURE_CAUSE_UNSPECIFIED Aucun motif d'échec n'est spécifié.
CLOUD_BUILD_UNAVAILABLE Cloud Build n'est pas disponible, soit parce qu'il n'est pas activé, soit parce que Cloud Deploy ne dispose pas des autorisations nécessaires. Consultez Autorisation requise.
EXECUTION_FAILED L'opération de postdéploiement ne s'est pas terminée correctement. Consultez les journaux Cloud Build.
DEADLINE_EXCEEDED L'exécution du job de postdéploiement ne s'est pas terminée dans le temps imparti.
CLOUD_BUILD_REQUEST_FAILED Cloud Build n'a pas pu traiter la requête de Cloud Deploy. Pour en savoir plus, consultez la section "failMessage".

CreateChildRolloutJobRun

CreateChildRolloutJobRun contient des informations spécifiques à un JobRun createChildRollout.

Représentation JSON 
{
  "rollout": string,
  "rolloutPhaseId": string
}
Champs
rollout

string

Uniquement en sortie. Nom du ChildRollout. Le format est le suivant : projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
rolloutPhaseId

string

Uniquement en sortie. ID de la phase de déploiement enfant initiée par ce JobRun.

AdvanceChildRolloutJobRun

AdvanceChildRolloutJobRun contient des informations spécifiques à un JobRun progressChildRollout.

Représentation JSON 
{
  "rollout": string,
  "rolloutPhaseId": string
}
Champs
rollout

string

Uniquement en sortie. Nom du ChildRollout. Le format est le suivant : projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
rolloutPhaseId

string

Uniquement en sortie. ID de la phase du ChildRollout.

Méthodes

get

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

list

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

terminate

 Met fin à une exécution de job dans un projet et un emplacement donnés.