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

Risorsa: JobRun

Una risorsa JobRun nell'API Cloud Deploy.

Un elemento JobRun contiene informazioni su una singola valutazione di un job Rollout.

Rappresentazione 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.
}
Campi
name

string

Facoltativo. Nome di JobRun. Il formato è projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.

uid

string

Solo output. Identificatore univoco di JobRun.

phaseId

string

Solo output. ID della fase Rollout a cui appartiene JobRun.

jobId

string

Solo output. ID del job Rollout a cui corrisponde questa JobRun.

createTime

string (Timestamp format)

Solo output. Ora in cui è stato creato l'elemento JobRun.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

startTime

string (Timestamp format)

Solo output. Ora in cui è stato avviato JobRun.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Solo output. Ora in cui è terminato JobRun.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Solo output. Lo stato attuale di JobRun.

etag

string

Solo output. Questo checksum viene calcolato dal server in base al valore di altri campi e può essere inviato in caso di richieste di aggiornamento ed eliminazione per garantire che il client abbia un valore aggiornato prima di procedere.

Campo di unione job_run. Il tipo JobRun e le relative informazioni. job_run può essere solo uno dei seguenti:
deployJobRun

object (DeployJobRun)

Solo output. Informazioni specifiche per un JobRun deployment.

verifyJobRun

object (VerifyJobRun)

Solo output. Informazioni specifiche per una verifica JobRun.

predeployJobRun

object (PredeployJobRun)

Solo output. Informazioni specifiche per un JobRun pre-deployment.

postdeployJobRun

object (PostdeployJobRun)

Solo output. Informazioni specifiche per un JobRun post-deployment.

createChildRolloutJobRun

object (CreateChildRolloutJobRun)

Solo output. Informazioni specifiche per un elemento JobRun createChildRollout.

advanceChildRolloutJobRun

object (AdvanceChildRolloutJobRun)

Solo output. Informazioni specifiche per un valore di avanzamentoChildRollout JobRun

Stato

Stati validi di JobRun.

Enum
STATE_UNSPECIFIED JobRun ha uno stato non specificato.
IN_PROGRESS L'elemento JobRun è in corso.
SUCCEEDED L'operazione JobRun è riuscita.
FAILED L'operazione JobRun non è riuscita.
TERMINATING Chiusura di JobRun in corso.
TERMINATED Il JobRun è stato chiuso.

DeployJobRun

DeployJobRun contiene informazioni specifiche per un JobRun di deployment.

Rappresentazione JSON
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string,
  "metadata": {
    object (DeployJobRunMetadata)
  },
  "artifact": {
    object (DeployArtifact)
  }
}
Campi
build

string

Solo output. Il nome della risorsa dell'oggetto Build di Cloud Build utilizzato per il deployment. Il formato è projects/{project}/locations/{location}/builds/{build}.

failureCause

enum (FailureCause)

Solo output. Il motivo per cui il deployment non è riuscito. Questo valore non verrà sempre specificato se il deployment è in corso o se l'operazione è riuscita.

failureMessage

string

Solo output. Informazioni aggiuntive sull'errore di deployment, se disponibili.

metadata

object (DeployJobRunMetadata)

Solo output. Metadati contenenti informazioni sull'esecuzione del job di deployment.

artifact

object (DeployArtifact)

Solo output. L'artefatto dell'esecuzione di un job di deployment, se disponibile.

FailureCause

Errori di deployment noti.

Enum
FAILURE_CAUSE_UNSPECIFIED Nessun motivo specificato per l'errore.
CLOUD_BUILD_UNAVAILABLE Cloud Build non è disponibile perché non è abilitato o perché Cloud Deploy non ha autorizzazioni sufficienti. Consulta Autorizzazione obbligatoria.
EXECUTION_FAILED L'operazione di deployment non è stata completata correttamente; controlla i log di Cloud Build.
DEADLINE_EXCEEDED L'esecuzione del job di deployment non è stata completata entro il tempo allocato.
MISSING_RESOURCES_FOR_CANARY Nell'ambiente di runtime mancavano delle risorse necessarie per un deployment canary. Per ulteriori informazioni, controlla i log di Cloud Build.
CLOUD_BUILD_REQUEST_FAILED Cloud Build non è riuscito a soddisfare la richiesta di Cloud Deploy. Per ulteriori dettagli, vedi failureMessage.
DEPLOY_FEATURE_NOT_SUPPORTED Nell'operazione di deployment è stata configurata una funzionalità non supportata.

DeployJobRunMetadata

DeployJobRunMetadata mostra all'utente le informazioni associate a un DeployJobRun.

Rappresentazione JSON
{
  "cloudRun": {
    object (CloudRunMetadata)
  },
  "customTarget": {
    object (CustomTargetDeployMetadata)
  },
  "custom": {
    object (CustomMetadata)
  }
}
Campi
cloudRun

object (CloudRunMetadata)

Solo output. Il nome del servizio Cloud Run associato a un DeployJobRun.

customTarget

object (CustomTargetDeployMetadata)

Solo output. Metadati del target personalizzato associati a un DeployJobRun.

custom

object (CustomMetadata)

Solo output. Metadati personalizzati forniti dall'operazione di deployment definita dall'utente.

CustomTargetDeployMetadata

CustomTargetDeployMetadata contiene informazioni provenienti da un'operazione di deployment con target personalizzato.

Rappresentazione JSON
{
  "skipMessage": string
}
Campi
skipMessage

string

Solo output. Salta il messaggio fornito nei risultati di un'operazione di deployment personalizzato.

DeployArtifact

Gli artefatti prodotti da un'operazione di deployment.

Rappresentazione JSON
{
  "artifactUri": string,
  "manifestPaths": [
    string
  ]
}
Campi
artifactUri

string

Solo output. URI di una directory contenente gli artefatti. Tutti i percorsi sono relativi a questa località.

manifestPaths[]

string

Solo output. Percorsi dei file dei manifest applicati durante l'operazione di deployment relativi all'URI.

VerifyJobRun

VerificationJobRun contiene informazioni specifiche per un tipo di verifica JobRun.

Rappresentazione JSON
{
  "build": string,
  "artifactUri": string,
  "eventLogPath": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Campi
build

string

Solo output. Il nome della risorsa dell'oggetto Build di Cloud Build utilizzato per la verifica. Il formato è projects/{project}/locations/{location}/builds/{build}.

artifactUri

string

Solo output. URI di una directory contenente gli artefatti di verifica. Contiene il log eventi di Skaffold.

eventLogPath

string

Solo output. Percorso del file del log eventi Skaffold relativo all'URI dell'artefatto.

failureCause

enum (FailureCause)

Solo output. Il motivo per cui la verifica non è riuscita. Questo valore non verrà sempre specificato se la verifica è in corso o se l'esito è positivo.

failureMessage

string

Solo output. Informazioni aggiuntive sull'errore di verifica, se disponibili.

FailureCause

Errori di verifica noti.

Enum
FAILURE_CAUSE_UNSPECIFIED Nessun motivo specificato per l'errore.
CLOUD_BUILD_UNAVAILABLE Cloud Build non è disponibile perché non è abilitato o perché Cloud Deploy non ha autorizzazioni sufficienti. Consulta l'autorizzazione richiesta.
EXECUTION_FAILED L'operazione di verifica non è stata completata correttamente; controlla i log di Cloud Build.
DEADLINE_EXCEEDED L'esecuzione del job di verifica non è stata completata entro il tempo allocato.
VERIFICATION_CONFIG_NOT_FOUND Nessuna configurazione di verifica Skaffold trovata.
CLOUD_BUILD_REQUEST_FAILED Cloud Build non è riuscito a soddisfare la richiesta di Cloud Deploy. Per ulteriori dettagli, vedi failureMessage.

PredeployJobRun

PredeployJobRun contiene informazioni specifiche per un JobRun pre-deployment.

Rappresentazione JSON
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Campi
build

string

Solo output. Il nome della risorsa dell'oggetto Build di Cloud Build utilizzato per eseguire le azioni personalizzate associate al job di pre-deployment. Il formato è projects/{project}/locations/{location}/builds/{build}.

failureCause

enum (FailureCause)

Solo output. Il motivo per cui il pre-deployment non è riuscito. Questo valore non verrà sempre specificato se il pre-deployment è in corso o se l'operazione ha avuto esito positivo.

failureMessage

string

Solo output. Informazioni aggiuntive sull'errore di pre-deployment, se disponibili.

FailureCause

Errori di pre-deployment noti.

Enum
FAILURE_CAUSE_UNSPECIFIED Nessun motivo specificato per l'errore.
CLOUD_BUILD_UNAVAILABLE Cloud Build non è disponibile perché non è abilitato o perché Cloud Deploy non ha autorizzazioni sufficienti. Consulta l'autorizzazione richiesta.
EXECUTION_FAILED L'operazione di pre-deployment non è stata completata correttamente; controlla i log di Cloud Build.
DEADLINE_EXCEEDED L'esecuzione del job di pre-deployment non è stata completata entro il tempo allocato.
CLOUD_BUILD_REQUEST_FAILED Cloud Build non è riuscito a soddisfare la richiesta di Cloud Deploy. Per ulteriori dettagli, vedi failureMessage.

PostdeployJobRun

PostdeployJobRun contiene informazioni specifiche per un elemento JobRun post-deployment.

Rappresentazione JSON
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Campi
build

string

Solo output. Il nome della risorsa dell'oggetto Build di Cloud Build utilizzato per eseguire le azioni personalizzate associate al job post-deployment. Il formato è projects/{project}/locations/{location}/builds/{build}.

failureCause

enum (FailureCause)

Solo output. Il motivo per cui il postdeployment non è riuscito. Questo valore non verrà sempre specificato se il post-deployment è in corso o se l'operazione ha esito positivo.

failureMessage

string

Solo output. Informazioni aggiuntive sull'errore post-deployment, se disponibili.

FailureCause

Errori post-deployment noti.

Enum
FAILURE_CAUSE_UNSPECIFIED Nessun motivo specificato per l'errore.
CLOUD_BUILD_UNAVAILABLE Cloud Build non è disponibile perché non è abilitato o perché Cloud Deploy non ha autorizzazioni sufficienti. Consulta l'autorizzazione richiesta.
EXECUTION_FAILED L'operazione post-deployment non è stata completata correttamente; controlla i log di Cloud Build.
DEADLINE_EXCEEDED L'esecuzione del job post-deployment non è stata completata entro il tempo allocato.
CLOUD_BUILD_REQUEST_FAILED Cloud Build non è riuscito a soddisfare la richiesta di Cloud Deploy. Per ulteriori dettagli, vedi failureMessage.

CreateChildRolloutJobRun

CreateChildRolloutJobRun contiene informazioni specifiche per un oggetto JobRun createChildRollout.

Rappresentazione JSON
{
  "rollout": string,
  "rolloutPhaseId": string
}
Campi
rollout

string

Solo output. Nome di ChildRollout. Il formato è projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

rolloutPhaseId

string

Solo output. L'ID della fase childRollout avviata da questa JobRun.

AdvanceChildRolloutJobRun

AdvanceChildRolloutJobRun contiene informazioni specifiche per un valore JobRun anticipato.

Rappresentazione JSON
{
  "rollout": string,
  "rolloutPhaseId": string
}
Campi
rollout

string

Solo output. Nome di ChildRollout. Il formato è projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

rolloutPhaseId

string

Solo output. L'ID della fase del ChildRollout.

Metodi

get

Recupera i dettagli di una singola JobRun.

list

Elenca le esecuzioni di JobRun in un progetto e in una località specifici.

terminate

Termina l'esecuzione di un job in un progetto e una località specifici.