Google Cloud Deploy V1 Client - Class JobRun (2.0.0)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class JobRun.

A JobRun resource in the Cloud Deploy API.

A JobRun contains information of a single Rollout job evaluation.

Generated from protobuf message google.cloud.deploy.v1.JobRun

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ 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 .

↳ phase_id
string

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

↳ job_id
string

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

↳ create_time
Google\Protobuf\Timestamp

Output only. Time at which the JobRun was created.

↳ start_time
Google\Protobuf\Timestamp

Output only. Time at which the JobRun was started.

↳ end_time
Google\Protobuf\Timestamp

Output only. Time at which the JobRun ended.

↳ state
int

Output only. The current state of the JobRun .

↳ deploy_job_run
Google\Cloud\Deploy\V1\DeployJobRun

Output only. Information specific to a deploy JobRun .

↳ verify_job_run
Google\Cloud\Deploy\V1\VerifyJobRun

Output only. Information specific to a verify JobRun .

↳ predeploy_job_run
Google\Cloud\Deploy\V1\PredeployJobRun

Output only. Information specific to a predeploy JobRun .

↳ postdeploy_job_run
Google\Cloud\Deploy\V1\PostdeployJobRun

Output only. Information specific to a postdeploy JobRun .

↳ create_child_rollout_job_run
Google\Cloud\Deploy\V1\CreateChildRolloutJobRun

Output only. Information specific to a createChildRollout JobRun .

↳ advance_child_rollout_job_run
Google\Cloud\Deploy\V1\AdvanceChildRolloutJobRun

Output only. Information specific to an advanceChildRollout 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.

getName

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

Returns
Type
Description
string

setName

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getUid

Output only. Unique identifier of the JobRun .

Returns
Type
Description
string

setUid

Output only. Unique identifier of the JobRun .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPhaseId

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

Returns
Type
Description
string

setPhaseId

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getJobId

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

Returns
Type
Description
string

setJobId

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. Time at which the JobRun was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time at which the JobRun was created.

Parameter
Name
Description
Returns
Type
Description
$this

getStartTime

Output only. Time at which the JobRun was started.

Returns
Type
Description

hasStartTime

clearStartTime

setStartTime

Output only. Time at which the JobRun was started.

Parameter
Name
Description
Returns
Type
Description
$this

getEndTime

Output only. Time at which the JobRun ended.

Returns
Type
Description

hasEndTime

clearEndTime

setEndTime

Output only. Time at which the JobRun ended.

Parameter
Name
Description
Returns
Type
Description
$this

getState

Output only. The current state of the JobRun .

Returns
Type
Description
int

setState

Output only. The current state of the JobRun .

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getDeployJobRun

Output only. Information specific to a deploy JobRun .

Returns
Type
Description

hasDeployJobRun

setDeployJobRun

Output only. Information specific to a deploy JobRun .

Parameter
Name
Description
Returns
Type
Description
$this

getVerifyJobRun

Output only. Information specific to a verify JobRun .

Returns
Type
Description

hasVerifyJobRun

setVerifyJobRun

Output only. Information specific to a verify JobRun .

Parameter
Name
Description
Returns
Type
Description
$this

getPredeployJobRun

Output only. Information specific to a predeploy JobRun .

Returns
Type
Description

hasPredeployJobRun

setPredeployJobRun

Output only. Information specific to a predeploy JobRun .

Parameter
Name
Description
Returns
Type
Description
$this

getPostdeployJobRun

Output only. Information specific to a postdeploy JobRun .

Returns
Type
Description

hasPostdeployJobRun

setPostdeployJobRun

Output only. Information specific to a postdeploy JobRun .

Parameter
Name
Description
Returns
Type
Description
$this

getCreateChildRolloutJobRun

Output only. Information specific to a createChildRollout JobRun .

Returns
Type
Description

hasCreateChildRolloutJobRun

setCreateChildRolloutJobRun

Output only. Information specific to a createChildRollout JobRun .

Parameter
Name
Description
Returns
Type
Description
$this

getAdvanceChildRolloutJobRun

Output only. Information specific to an advanceChildRollout JobRun

Returns
Type
Description

hasAdvanceChildRolloutJobRun

setAdvanceChildRolloutJobRun

Output only. Information specific to an advanceChildRollout JobRun

Parameter
Name
Description
Returns
Type
Description
$this

getEtag

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.

Returns
Type
Description
string

setEtag

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getJobRun

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: