job_runs

Creates, updates, deletes, gets or lists a job_runs resource.

Overview

Name	job_runs
Type	Resource
Id	google.clouddeploy.job_runs

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Name of the JobRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.
advanceChildRolloutJobRun	object	Output only. Information specific to an advanceChildRollout JobRun (id: AdvanceChildRolloutJobRun)
createChildRolloutJobRun	object	Output only. Information specific to a createChildRollout JobRun. (id: CreateChildRolloutJobRun)
createTime	string (google-datetime)	Output only. Time at which the JobRun was created.
deployJobRun	object	Output only. Information specific to a deploy JobRun. (id: DeployJobRun)
endTime	string (google-datetime)	Output only. Time at which the JobRun ended.
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.
jobId	string	Output only. ID of the Rollout job this JobRun corresponds to.
phaseId	string	Output only. ID of the Rollout phase this JobRun belongs in.
postdeployJobRun	object	Output only. Information specific to a postdeploy JobRun. (id: PostdeployJobRun)
predeployJobRun	object	Output only. Information specific to a predeploy JobRun. (id: PredeployJobRun)
startTime	string (google-datetime)	Output only. Time at which the JobRun was started.
state	string	Output only. The current state of the JobRun.
uid	string	Output only. Unique identifier of the JobRun.
verifyJobRun	object	Output only. Information specific to a verify JobRun. (id: VerifyJobRun)

list

Successful response

Name	Datatype	Description
name	string	Output only. Name of the JobRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.
advanceChildRolloutJobRun	object	Output only. Information specific to an advanceChildRollout JobRun (id: AdvanceChildRolloutJobRun)
createChildRolloutJobRun	object	Output only. Information specific to a createChildRollout JobRun. (id: CreateChildRolloutJobRun)
createTime	string (google-datetime)	Output only. Time at which the JobRun was created.
deployJobRun	object	Output only. Information specific to a deploy JobRun. (id: DeployJobRun)
endTime	string (google-datetime)	Output only. Time at which the JobRun ended.
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.
jobId	string	Output only. ID of the Rollout job this JobRun corresponds to.
phaseId	string	Output only. ID of the Rollout phase this JobRun belongs in.
postdeployJobRun	object	Output only. Information specific to a postdeploy JobRun. (id: PostdeployJobRun)
predeployJobRun	object	Output only. Information specific to a predeploy JobRun. (id: PredeployJobRun)
startTime	string (google-datetime)	Output only. Time at which the JobRun was started.
state	string	Output only. The current state of the JobRun.
uid	string	Output only. Unique identifier of the JobRun.
verifyJobRun	object	Output only. Information specific to a verify JobRun. (id: VerifyJobRun)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, deliveryPipelinesId, releasesId, rolloutsId, jobRunsId		Gets details of a single JobRun.
list	select	projectsId, locationsId, deliveryPipelinesId, releasesId, rolloutsId	pageSize, pageToken, filter, orderBy	Lists JobRuns in a given project and location.
terminate	exec	projectsId, locationsId, deliveryPipelinesId, releasesId, rolloutsId, jobRunsId		Terminates a Job Run in a given project and location.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deliveryPipelinesId	string
jobRunsId	string
locationsId	string
projectsId	string
releasesId	string
rolloutsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets details of a single JobRun.

SELECT
name,
advanceChildRolloutJobRun,
createChildRolloutJobRun,
createTime,
deployJobRun,
endTime,
etag,
jobId,
phaseId,
postdeployJobRun,
predeployJobRun,
startTime,
state,
uid,
verifyJobRun
FROM google.clouddeploy.job_runs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' -- required
AND releasesId = '{{ releasesId }}' -- required
AND rolloutsId = '{{ rolloutsId }}' -- required
AND jobRunsId = '{{ jobRunsId }}' -- required;

list

Lists JobRuns in a given project and location.

SELECT
name,
advanceChildRolloutJobRun,
createChildRolloutJobRun,
createTime,
deployJobRun,
endTime,
etag,
jobId,
phaseId,
postdeployJobRun,
predeployJobRun,
startTime,
state,
uid,
verifyJobRun
FROM google.clouddeploy.job_runs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' -- required
AND releasesId = '{{ releasesId }}' -- required
AND rolloutsId = '{{ rolloutsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

Lifecycle Methods

terminate

Terminates a Job Run in a given project and location.

EXEC google.clouddeploy.job_runs.terminate 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@deliveryPipelinesId='{{ deliveryPipelinesId }}' --required, 
@releasesId='{{ releasesId }}' --required, 
@rolloutsId='{{ rolloutsId }}' --required, 
@jobRunsId='{{ jobRunsId }}' --required 
@@json=
'{
"overrideDeployPolicy": "{{ overrideDeployPolicy }}"
}';