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

Recurso: JobRun

Um recurso JobRun na API Cloud Deploy.

Um JobRun contém informações de uma única avaliação de job Rollout.

Representação 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.
}
Campos
name

string

Opcional. Nome da JobRun. O formato é projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.
uid

string

Apenas saída. Identificador exclusivo do JobRun.
phaseId

string

Apenas saída. ID da fase Rollout a que JobRun pertence.
jobId

string

Apenas saída. ID do job Rollout a que esse JobRun corresponde.
createTime

string (Timestamp format)

Apenas saída. Horário em que o JobRun foi criado.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
startTime

string (Timestamp format)

Apenas saída. Horário em que o JobRun foi iniciado.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Apenas saída. Horário em que o JobRun terminou.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Apenas saída. O estado atual da JobRun.
etag

string

Apenas saída. Essa soma de verificação é calculada pelo servidor com base no valor de outros campos e pode ser enviada em solicitações de atualização e exclusão para garantir que o cliente tenha um valor atualizado antes de continuar.
Campo de união job_run. O tipo JobRun e as informações desse tipo. job_run pode ser apenas de um dos tipos a seguir:
deployJobRun

object (DeployJobRun)

Apenas saída. Informações específicas de uma implantação JobRun.
verifyJobRun

object (VerifyJobRun)

Apenas saída. Informações específicas de um JobRun verificado.
predeployJobRun

object (PredeployJobRun)

Apenas saída. Informações específicas de uma pré-implantação JobRun.
postdeployJobRun

object (PostdeployJobRun)

Apenas saída. Informações específicas de uma JobRun pós-implantação.
createChildRolloutJobRun

object (CreateChildRolloutJobRun)

Apenas saída. Informações específicas de um JobRun de createChild criança.
advanceChildRolloutJobRun

object (AdvanceChildRolloutJobRun)

Apenas saída. Informações específicas de um avançoChildLaunch JobRun

Estado

Estados válidos de um JobRun.

Tipos enumerados
STATE_UNSPECIFIED O JobRun tem um estado não especificado.
IN_PROGRESS A JobRun está em andamento.
SUCCEEDED A operação JobRun foi concluída.
FAILED Ocorreu uma falha no JobRun.
TERMINATING O JobRun está sendo encerrado.
TERMINATED A JobRun foi encerrada.

DeployJobRun

O DeployJobRun contém informações específicas para uma implantação JobRun.

Representação JSON 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string,
  "metadata": {
    object (DeployJobRunMetadata)
  },
  "artifact": {
    object (DeployArtifact)
  }
}
Campos
build

string

Apenas saída. O nome do recurso do objeto Build do Cloud Build que é usado para a implantação. O formato é projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Apenas saída. O motivo da falha na implantação. Ele sempre não será especificado enquanto a implantação estiver em andamento ou se tiver sido bem-sucedida.
failureMessage

string

Apenas saída. Informações adicionais sobre a falha na implantação, se disponíveis.
metadata

object (DeployJobRunMetadata)

Apenas saída. Metadados contendo informações sobre a execução do job de implantação.
artifact

object (DeployArtifact)

Apenas saída. O artefato de uma execução de job de implantação, se disponível.

FailureCause

Falhas conhecidas de implantação.

Tipos enumerados
FAILURE_CAUSE_UNSPECIFIED Nenhum motivo para a falha foi especificado.
CLOUD_BUILD_UNAVAILABLE O Cloud Build não está disponível porque não está ativado ou porque o Cloud Deploy não tem permissões suficientes. Consulte a Permissão necessária.
EXECUTION_FAILED A operação de implantação não foi concluída com sucesso. Verifique os registros do Cloud Build.
DEADLINE_EXCEEDED A execução do job de implantação não foi concluída no tempo alocado.
MISSING_RESOURCES_FOR_CANARY Não havia recursos no ambiente de execução necessários para uma implantação canário. Verifique os registros do Cloud Build para mais informações.
CLOUD_BUILD_REQUEST_FAILED O Cloud Build falhou ao atender à solicitação do Cloud Deploy. Consulte failedMessage para mais detalhes.
DEPLOY_FEATURE_NOT_SUPPORTED A operação de implantação tem um recurso configurado que não é compatível.

DeployJobRunMetadata

O DeployJobRunMetadata mostra informações associadas a um DeployJobRun para o usuário.

Representação JSON 
{
  "cloudRun": {
    object (CloudRunMetadata)
  },
  "customTarget": {
    object (CustomTargetDeployMetadata)
  },
  "custom": {
    object (CustomMetadata)
  }
}
Campos
cloudRun

object (CloudRunMetadata)

Apenas saída. O nome do serviço do Cloud Run associado a um DeployJobRun.
customTarget

object (CustomTargetDeployMetadata)

Apenas saída. Metadados de destino personalizado associados a um DeployJobRun.
custom

object (CustomMetadata)

Apenas saída. Metadados personalizados fornecidos por operação de implantação definida pelo usuário.

CustomTargetDeployMetadata

CustomTargetDeployMetadata contém informações de uma operação de implantação de destino personalizado.

Representação JSON 
{
  "skipMessage": string
}
Campos
skipMessage

string

Apenas saída. Pular mensagem fornecida nos resultados de uma operação de implantação personalizada.

DeployArtifact

Os artefatos produzidos por uma operação de implantação.

Representação JSON 
{
  "artifactUri": string,
  "manifestPaths": [
    string
  ]
}
Campos
artifactUri

string

Apenas saída. URI de um diretório que contém os artefatos. Todos os caminhos são relativos a esse local.
manifestPaths[]

string

Apenas saída. Caminhos de arquivo dos manifestos aplicados durante a operação de implantação em relação ao URI.

VerifyJobRun

VerifyJobRun contém informações específicas para um JobRun verificado.

Representação JSON 
{
  "build": string,
  "artifactUri": string,
  "eventLogPath": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Campos
build

string

Apenas saída. O nome do recurso do objeto Build do Cloud Build que é usado para verificação. O formato é projects/{project}/locations/{location}/builds/{build}.
artifactUri

string

Apenas saída. URI de um diretório que contém os artefatos de verificação. Contém o log de eventos do Skaffold.
eventLogPath

string

Apenas saída. Caminho de arquivo do log de eventos do Skaffold relativo ao URI do artefato.
failureCause

enum (FailureCause)

Apenas saída. O motivo da falha na verificação. Ele sempre não será especificado enquanto a verificação estiver em andamento ou se tiver sido bem-sucedida.
failureMessage

string

Apenas saída. Informações adicionais sobre a falha da verificação, se disponíveis.

FailureCause

Falhas de verificação conhecidas.

Tipos enumerados
FAILURE_CAUSE_UNSPECIFIED Nenhum motivo para a falha foi especificado.
CLOUD_BUILD_UNAVAILABLE O Cloud Build não está disponível porque não está ativado ou porque o Cloud Deploy não tem permissões suficientes. Consulte a permissão necessária.
EXECUTION_FAILED A operação de verificação não foi concluída. Verifique os registros do Cloud Build.
DEADLINE_EXCEEDED A execução do job de verificação não foi concluída no tempo alocado.
VERIFICATION_CONFIG_NOT_FOUND Nenhuma configuração de verificação do Skaffold foi encontrada.
CLOUD_BUILD_REQUEST_FAILED O Cloud Build falhou ao atender à solicitação do Cloud Deploy. Consulte failedMessage para mais detalhes.

PredeployJobRun

PredeployJobRun contém informações específicas para uma pré-implantação JobRun.

Representação JSON 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Campos
build

string

Apenas saída. O nome do recurso do objeto Build do Cloud Build que é usado para executar as ações personalizadas associadas ao job de pré-implantação. O formato é projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Apenas saída. O motivo da falha na pré-implantação. Ela não será especificada enquanto a pré-implantação estiver em andamento ou se tiver sido bem-sucedida.
failureMessage

string

Apenas saída. Informações adicionais sobre a falha de pré-implantação, se disponíveis.

FailureCause

Falhas de pré-implantação conhecidas.

Tipos enumerados
FAILURE_CAUSE_UNSPECIFIED Nenhum motivo para a falha foi especificado.
CLOUD_BUILD_UNAVAILABLE O Cloud Build não está disponível porque não está ativado ou porque o Cloud Deploy não tem permissões suficientes. Consulte a permissão necessária.
EXECUTION_FAILED A operação de pré-implantação não foi concluída com sucesso. Verifique os registros do Cloud Build.
DEADLINE_EXCEEDED A execução do job de pré-implantação não foi concluída no tempo alocado.
CLOUD_BUILD_REQUEST_FAILED O Cloud Build falhou ao atender à solicitação do Cloud Deploy. Consulte failedMessage para mais detalhes.

PostdeployJobRun

O PostdeployJobRun contém informações específicas para uma JobRun pós-implantação.

Representação JSON 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Campos
build

string

Apenas saída. O nome do recurso do objeto Build do Cloud Build que é usado para executar as ações personalizadas associadas ao job pós-implantação. O formato é projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Apenas saída. O motivo da falha da pós-implantação. Esse valor não será especificado enquanto a pós-implantação estiver em andamento ou se tiver sido bem-sucedida.
failureMessage

string

Apenas saída. Informações adicionais sobre a falha pós-implantação, se disponíveis.

FailureCause

Falhas conhecidas de pós-implantação.

Tipos enumerados
FAILURE_CAUSE_UNSPECIFIED Nenhum motivo para a falha foi especificado.
CLOUD_BUILD_UNAVAILABLE O Cloud Build não está disponível porque não está ativado ou porque o Cloud Deploy não tem permissões suficientes. Consulte a permissão necessária.
EXECUTION_FAILED A operação de pós-implantação não foi concluída com sucesso. Verifique os registros do Cloud Build.
DEADLINE_EXCEEDED A execução do job de pós-implantação não foi concluída no tempo alocado.
CLOUD_BUILD_REQUEST_FAILED O Cloud Build falhou ao atender à solicitação do Cloud Deploy. Consulte failedMessage para mais detalhes.

CreateChildRolloutJobRun

CreateChildLaunchJobRun contém informações específicas a um JobRun createChild necessários.

Representação JSON 
{
  "rollout": string,
  "rolloutPhaseId": string
}
Campos
rollout

string

Apenas saída. Nome da ChildRollout. O formato é projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
rolloutPhaseId

string

Apenas saída. O ID da fase child ação iniciada por este JobRun.

AdvanceChildRolloutJobRun

AdvanceChildLaunchJobRun contém informações específicas para um JobRunAdvanceChild apropriada.

Representação JSON 
{
  "rollout": string,
  "rolloutPhaseId": string
}
Campos
rollout

string

Apenas saída. Nome da ChildRollout. O formato é projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
rolloutPhaseId

string

Apenas saída. O ID da Fase do Childativa.

Métodos

get

 Recebe detalhes de um único JobRun.

list

 Lista os JobRuns em um determinado projeto e local.

terminate

 Encerra uma execução de job em um determinado projeto e local.