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

Recurso: JobRun

Un recurso JobRun en la API de Cloud Deploy.

Una JobRun contiene información de una única evaluación de trabajo Rollout.

Representación 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. Es el nombre de JobRun. El formato es projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.
uid

string

Solo salida. Es el identificador único de JobRun.
phaseId

string

Solo salida. ID de la fase Rollout a la que pertenece este JobRun.
jobId

string

Solo salida. ID del trabajo Rollout al que corresponde esta JobRun.
createTime

string (Timestamp format)

Solo salida. Hora en la que se creó el JobRun.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
startTime

string (Timestamp format)

Solo salida. Hora a la que se inició el JobRun.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Solo salida. Hora a la que finalizó el evento JobRun.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Solo salida. El estado actual de JobRun.
etag

string

Solo salida. El servidor calcula esta suma de verificación según el valor de otros campos, y puede enviarse en las solicitudes de actualización y eliminación para garantizar que el cliente tenga un valor actualizado antes de continuar.
Campo de unión job_run. El tipo JobRun y la información para ese tipo job_run puede ser solo uno de los siguientes:
deployJobRun

object (DeployJobRun)

Solo salida. Información específica de una implementación JobRun.
verifyJobRun

object (VerifyJobRun)

Solo salida. Información específica de un JobRun de verificación.
predeployJobRun

object (PredeployJobRun)

Solo salida. Información específica de una JobRun previa a la implementación.
postdeployJobRun

object (PostdeployJobRun)

Solo salida. Información específica de JobRun posterior a la implementación.
createChildRolloutJobRun

object (CreateChildRolloutJobRun)

Solo salida. Información específica de un JobRun de createChildRollout.
advanceChildRolloutJobRun

object (AdvanceChildRolloutJobRun)

Solo salida. Información específica de un AdvantageChildRollout JobRun

Estado

Los estados válidos de un JobRun

Enums
STATE_UNSPECIFIED El estado de JobRun no está especificado.
IN_PROGRESS La JobRun está en curso.
SUCCEEDED JobRun se realizó correctamente.
FAILED El JobRun falló.
TERMINATING Se está finalizando JobRun.
TERMINATED Se cerró el JobRun.

DeployJobRun

DeployJobRun contiene información específica de JobRun de implementación.

Representación JSON 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string,
  "metadata": {
    object (DeployJobRunMetadata)
  },
  "artifact": {
    object (DeployArtifact)
  }
}
Campos
build

string

Solo salida. El nombre del recurso del objeto Build de Cloud Build que se usa para la implementación. El formato es projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Solo salida. El motivo por el que falló la implementación. Esto siempre no se especificará mientras la implementación esté en curso o si se realizó correctamente.
failureMessage

string

Solo salida. Información adicional sobre la falla de implementación, si está disponible.
metadata

object (DeployJobRunMetadata)

Solo salida. Metadatos que contienen información sobre la ejecución del trabajo de implementación.
artifact

object (DeployArtifact)

Solo salida. El artefacto de una ejecución de trabajo de implementación, si está disponible.

FailureCause

Fallas de implementación conocidas.

Enums
FAILURE_CAUSE_UNSPECIFIED No se especifica ningún motivo para la falla.
CLOUD_BUILD_UNAVAILABLE Cloud Build no está disponible, ya sea porque no está habilitado o porque Cloud Deploy tiene permisos insuficientes. Consulta Permiso necesario.
EXECUTION_FAILED La operación de implementación no se completó correctamente. Revisa los registros de Cloud Build.
DEADLINE_EXCEEDED La ejecución del trabajo de implementación no se completó en el tiempo asignado.
MISSING_RESOURCES_FOR_CANARY Faltaban recursos en el entorno de ejecución necesarios para la implementación de versiones canary. Consulta los registros de Cloud Build para obtener más información.
CLOUD_BUILD_REQUEST_FAILED Cloud Build no pudo completar la solicitud de Cloud Deploy. Consulta failedMessage para obtener más detalles.
DEPLOY_FEATURE_NOT_SUPPORTED La operación de implementación tenía una función configurada que no es compatible.

DeployJobRunMetadata

DeployJobRunMetadata muestra al usuario información asociada con un DeployJobRun.

Representación JSON 
{
  "cloudRun": {
    object (CloudRunMetadata)
  },
  "customTarget": {
    object (CustomTargetDeployMetadata)
  },
  "custom": {
    object (CustomMetadata)
  }
}
Campos
cloudRun

object (CloudRunMetadata)

Solo salida. Es el nombre del servicio de Cloud Run que está asociado a un DeployJobRun.
customTarget

object (CustomTargetDeployMetadata)

Solo salida. Metadatos del destino personalizado asociados con un DeployJobRun
custom

object (CustomMetadata)

Solo salida. Metadatos personalizados que proporciona la operación de implementación definida por el usuario.

CustomTargetDeployMetadata

CustomTargetDeployMetadata contiene información de una operación de implementación de destino personalizado.

Representación JSON 
{
  "skipMessage": string
}
Campos
skipMessage

string

Solo salida. Mensaje de omisión que se proporciona en los resultados de una operación de implementación personalizada.

DeployArtifact

Los artefactos que produce una operación de implementación

Representación JSON 
{
  "artifactUri": string,
  "manifestPaths": [
    string
  ]
}
Campos
artifactUri

string

Solo salida. El URI de un directorio que contiene los artefactos. Todas las rutas están relacionadas con esta ubicación.
manifestPaths[]

string

Solo salida. Rutas de acceso a archivos de los manifiestos que se aplicaron durante la operación de implementación en relación con el URI.

VerifyJobRun

VerifyJobRun contiene información específica de un JobRun de verificación.

Representación JSON 
{
  "build": string,
  "artifactUri": string,
  "eventLogPath": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Campos
build

string

Solo salida. El nombre del recurso del objeto Build de Cloud Build que se usa para la verificación. El formato es projects/{project}/locations/{location}/builds/{build}.
artifactUri

string

Solo salida. El URI de un directorio que contiene los artefactos de verificación. Contiene el registro de eventos de Skaffold.
eventLogPath

string

Solo salida. Es la ruta de acceso al archivo del registro de eventos de Skaffold en relación con el URI del artefacto.
failureCause

enum (FailureCause)

Solo salida. El motivo por el que falló la verificación. Esto siempre no se especificará mientras la verificación esté en curso o si se realizó correctamente.
failureMessage

string

Solo salida. Información adicional sobre el error de verificación, si está disponible.

FailureCause

Fallas de verificación conocidas.

Enums
FAILURE_CAUSE_UNSPECIFIED No se especifica ningún motivo para la falla.
CLOUD_BUILD_UNAVAILABLE Cloud Build no está disponible, ya sea porque no está habilitado o porque Cloud Deploy tiene permisos insuficientes. Consulta los permisos necesarios.
EXECUTION_FAILED La operación de verificación no se completó correctamente. Revisa los registros de Cloud Build.
DEADLINE_EXCEEDED La ejecución del trabajo de verificación no se completó en el tiempo asignado.
VERIFICATION_CONFIG_NOT_FOUND No se encontró ninguna configuración de verificación de Skaffold.
CLOUD_BUILD_REQUEST_FAILED Cloud Build no pudo completar la solicitud de Cloud Deploy. Consulta failedMessage para obtener más detalles.

PredeployJobRun

PredeployJobRun contiene información específica de una JobRun de implementación previa.

Representación JSON 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Campos
build

string

Solo salida. El nombre del recurso del objeto Build de Cloud Build que se usa para ejecutar las acciones personalizadas asociadas con el trabajo previo a la implementación. El formato es projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Solo salida. El motivo por el que falló la implementación previa. Esto siempre no se especificará mientras la implementación previa esté en curso o si se realizó correctamente.
failureMessage

string

Solo salida. Información adicional sobre la falla previa a la implementación, si está disponible.

FailureCause

Fallas conocidas previas a la implementación.

Enums
FAILURE_CAUSE_UNSPECIFIED No se especifica ningún motivo para la falla.
CLOUD_BUILD_UNAVAILABLE Cloud Build no está disponible, ya sea porque no está habilitado o porque Cloud Deploy tiene permisos insuficientes. Consulta los permisos necesarios.
EXECUTION_FAILED No se completó correctamente la operación previa a la implementación. Revisa los registros de Cloud Build.
DEADLINE_EXCEEDED La ejecución del trabajo previo a la implementación no se completó en el tiempo asignado.
CLOUD_BUILD_REQUEST_FAILED Cloud Build no pudo completar la solicitud de Cloud Deploy. Consulta failedMessage para obtener más detalles.

PostdeployJobRun

PostdeployJobRun contiene información específica de una JobRun posterior a la implementación.

Representación JSON 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Campos
build

string

Solo salida. El nombre del recurso del objeto Build de Cloud Build que se usa para ejecutar las acciones personalizadas asociadas con el trabajo posterior a la implementación. El formato es projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Solo salida. El motivo por el que falló la implementación posterior. Esto siempre no se especificará mientras la implementación posterior esté en curso o si se realizó correctamente.
failureMessage

string

Solo salida. Información adicional sobre la falla posterior a la implementación, si está disponible.

FailureCause

Fallas conocidas posteriores a la implementación.

Enums
FAILURE_CAUSE_UNSPECIFIED No se especifica ningún motivo para la falla.
CLOUD_BUILD_UNAVAILABLE Cloud Build no está disponible, ya sea porque no está habilitado o porque Cloud Deploy tiene permisos insuficientes. Consulta los permisos necesarios.
EXECUTION_FAILED La operación posterior a la implementación no se completó correctamente. Revisa los registros de Cloud Build.
DEADLINE_EXCEEDED La ejecución del trabajo posterior a la implementación no se completó en el tiempo asignado.
CLOUD_BUILD_REQUEST_FAILED Cloud Build no pudo completar la solicitud de Cloud Deploy. Consulta failedMessage para obtener más detalles.

CreateChildRolloutJobRun

CreateChildRolloutJobRun contiene información específica de un JobRun de createChildRollout.

Representación JSON 
{
  "rollout": string,
  "rolloutPhaseId": string
}
Campos
rollout

string

Solo salida. Es el nombre de ChildRollout. El formato es projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
rolloutPhaseId

string

Solo salida. El ID de la fase de desarrollo secundario que inició esta JobRun.

AdvanceChildRolloutJobRun

AdvanceChildRolloutJobRun contiene información específica de un JobRunAdvanceChildRollout.

Representación JSON 
{
  "rollout": string,
  "rolloutPhaseId": string
}
Campos
rollout

string

Solo salida. Es el nombre de ChildRollout. El formato es projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
rolloutPhaseId

string

Solo de salida. El ID de la fase de ChildRollout.

Métodos

get

 Obtiene detalles de un solo JobRun.

list

 Muestra una lista de JobRuns en un proyecto y una ubicación determinados.

terminate

 Finaliza una ejecución de trabajo en un proyecto y una ubicación determinados.