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

Resource: JobRun

A JobRun resource in the Cloud Deploy API.

A JobRun contains information of a single Rollout job evaluation.

JSON representation 
{
  "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.
}
Fields
name

string

Optional. Name of the JobRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.
uid

string

Output only. Unique identifier of the JobRun.
phaseId

string

Output only. ID of the Rollout phase this JobRun belongs in.
jobId

string

Output only. ID of the Rollout job this JobRun corresponds to.
createTime

string (Timestamp format)

Output only. Time at which the JobRun was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
startTime

string (Timestamp format)

Output only. Time at which the JobRun was started.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Output only. Time at which the JobRun ended.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. The current state of the JobRun.
etag

string

Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Union field job_run. The JobRun type and the information for that type. job_run can be only one of the following:
deployJobRun

object (DeployJobRun)

Output only. Information specific to a deploy JobRun.
verifyJobRun

object (VerifyJobRun)

Output only. Information specific to a verify JobRun.
predeployJobRun

object (PredeployJobRun)

Output only. Information specific to a predeploy JobRun.
postdeployJobRun

object (PostdeployJobRun)

Output only. Information specific to a postdeploy JobRun.
createChildRolloutJobRun

object (CreateChildRolloutJobRun)

Output only. Information specific to a createChildRollout JobRun.
advanceChildRolloutJobRun

object (AdvanceChildRolloutJobRun)

Output only. Information specific to an advanceChildRollout JobRun

State

Valid states of a JobRun.

Enums
STATE_UNSPECIFIED The JobRun has an unspecified state.
IN_PROGRESS The JobRun is in progress.
SUCCEEDED The JobRun has succeeded.
FAILED The JobRun has failed.
TERMINATING The JobRun is terminating.
TERMINATED The JobRun was terminated.

DeployJobRun

DeployJobRun contains information specific to a deploy JobRun.

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

string

Output only. The resource name of the Cloud Build Build object that is used to deploy. Format is projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded.
failureMessage

string

Output only. Additional information about the deploy failure, if available.
metadata

object (DeployJobRunMetadata)

Output only. Metadata containing information about the deploy job run.
artifact

object (DeployArtifact)

Output only. The artifact of a deploy job run, if available.

FailureCause

Well-known deploy failures.

Enums
FAILURE_CAUSE_UNSPECIFIED No reason for failure is specified.
CLOUD_BUILD_UNAVAILABLE Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See Required permission.
EXECUTION_FAILED The deploy operation did not complete successfully; check Cloud Build logs.
DEADLINE_EXCEEDED The deploy job run did not complete within the alloted time.
MISSING_RESOURCES_FOR_CANARY There were missing resources in the runtime environment required for a canary deployment. Check the Cloud Build logs for more information.
CLOUD_BUILD_REQUEST_FAILED Cloud Build failed to fulfill Cloud Deploy's request. See failureMessage for additional details.
DEPLOY_FEATURE_NOT_SUPPORTED The deploy operation had a feature configured that is not supported.

DeployJobRunMetadata

DeployJobRunMetadata surfaces information associated with a DeployJobRun to the user.

JSON representation 
{
  "cloudRun": {
    object (CloudRunMetadata)
  },
  "customTarget": {
    object (CustomTargetDeployMetadata)
  },
  "custom": {
    object (CustomMetadata)
  }
}
Fields
cloudRun

object (CloudRunMetadata)

Output only. The name of the Cloud Run Service that is associated with a DeployJobRun.
customTarget

object (CustomTargetDeployMetadata)

Output only. Custom Target metadata associated with a DeployJobRun.
custom

object (CustomMetadata)

Output only. Custom metadata provided by user-defined deploy operation.

CustomTargetDeployMetadata

CustomTargetDeployMetadata contains information from a Custom Target deploy operation.

JSON representation 
{
  "skipMessage": string
}
Fields
skipMessage

string

Output only. Skip message provided in the results of a custom deploy operation.

DeployArtifact

The artifacts produced by a deploy operation.

JSON representation 
{
  "artifactUri": string,
  "manifestPaths": [
    string
  ]
}
Fields
artifactUri

string

Output only. URI of a directory containing the artifacts. All paths are relative to this location.
manifestPaths[]

string

Output only. File paths of the manifests applied during the deploy operation relative to the URI.

VerifyJobRun

VerifyJobRun contains information specific to a verify JobRun.

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

string

Output only. The resource name of the Cloud Build Build object that is used to verify. Format is projects/{project}/locations/{location}/builds/{build}.
artifactUri

string

Output only. URI of a directory containing the verify artifacts. This contains the Skaffold event log.
eventLogPath

string

Output only. File path of the Skaffold event log relative to the artifact URI.
failureCause

enum (FailureCause)

Output only. The reason the verify failed. This will always be unspecified while the verify is in progress or if it succeeded.
failureMessage

string

Output only. Additional information about the verify failure, if available.

FailureCause

Well-known verify failures.

Enums
FAILURE_CAUSE_UNSPECIFIED No reason for failure is specified.
CLOUD_BUILD_UNAVAILABLE Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See required permission.
EXECUTION_FAILED The verify operation did not complete successfully; check Cloud Build logs.
DEADLINE_EXCEEDED The verify job run did not complete within the alloted time.
VERIFICATION_CONFIG_NOT_FOUND No Skaffold verify configuration was found.
CLOUD_BUILD_REQUEST_FAILED Cloud Build failed to fulfill Cloud Deploy's request. See failureMessage for additional details.

PredeployJobRun

PredeployJobRun contains information specific to a predeploy JobRun.

JSON representation 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Fields
build

string

Output only. The resource name of the Cloud Build Build object that is used to execute the custom actions associated with the predeploy Job. Format is projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Output only. The reason the predeploy failed. This will always be unspecified while the predeploy is in progress or if it succeeded.
failureMessage

string

Output only. Additional information about the predeploy failure, if available.

FailureCause

Well-known predeploy failures.

Enums
FAILURE_CAUSE_UNSPECIFIED No reason for failure is specified.
CLOUD_BUILD_UNAVAILABLE Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See required permission.
EXECUTION_FAILED The predeploy operation did not complete successfully; check Cloud Build logs.
DEADLINE_EXCEEDED The predeploy job run did not complete within the alloted time.
CLOUD_BUILD_REQUEST_FAILED Cloud Build failed to fulfill Cloud Deploy's request. See failureMessage for additional details.

PostdeployJobRun

PostdeployJobRun contains information specific to a postdeploy JobRun.

JSON representation 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Fields
build

string

Output only. The resource name of the Cloud Build Build object that is used to execute the custom actions associated with the postdeploy Job. Format is projects/{project}/locations/{location}/builds/{build}.
failureCause

enum (FailureCause)

Output only. The reason the postdeploy failed. This will always be unspecified while the postdeploy is in progress or if it succeeded.
failureMessage

string

Output only. Additional information about the postdeploy failure, if available.

FailureCause

Well-known postdeploy failures.

Enums
FAILURE_CAUSE_UNSPECIFIED No reason for failure is specified.
CLOUD_BUILD_UNAVAILABLE Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See required permission.
EXECUTION_FAILED The postdeploy operation did not complete successfully; check Cloud Build logs.
DEADLINE_EXCEEDED The postdeploy job run did not complete within the alloted time.
CLOUD_BUILD_REQUEST_FAILED Cloud Build failed to fulfill Cloud Deploy's request. See failureMessage for additional details.

CreateChildRolloutJobRun

CreateChildRolloutJobRun contains information specific to a createChildRollout JobRun.

JSON representation 
{
  "rollout": string,
  "rolloutPhaseId": string
}
Fields
rollout

string

Output only. Name of the ChildRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
rolloutPhaseId

string

Output only. The ID of the childRollout Phase initiated by this JobRun.

AdvanceChildRolloutJobRun

AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout JobRun.

JSON representation 
{
  "rollout": string,
  "rolloutPhaseId": string
}
Fields
rollout

string

Output only. Name of the ChildRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
rolloutPhaseId

string

Output only. the ID of the ChildRollout's Phase.

Methods

get

 Gets details of a single JobRun.

list

 Lists JobRuns in a given project and location.

terminate

 Terminates a Job Run in a given project and location.