Google Cloud Deploy V1 Client - Class JobRun (0.8.0)

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

A JobRun resource in the Google 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
NameDescription
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.

↳ 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
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUid

Output only. Unique identifier of the JobRun.

Returns
TypeDescription
string

setUid

Output only. Unique identifier of the JobRun.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPhaseId

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

Returns
TypeDescription
string

setPhaseId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJobId

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

Returns
TypeDescription
string

setJobId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Time at which the JobRun was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time at which the JobRun was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getStartTime

Output only. Time at which the JobRun was started.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. Time at which the JobRun was started.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

Output only. Time at which the JobRun ended.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. Time at which the JobRun ended.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getState

Output only. The current state of the JobRun.

Returns
TypeDescription
int

setState

Output only. The current state of the JobRun.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDeployJobRun

Output only. Information specific to a deploy JobRun.

Returns
TypeDescription
Google\Cloud\Deploy\V1\DeployJobRun|null

hasDeployJobRun

setDeployJobRun

Output only. Information specific to a deploy JobRun.

Parameter
NameDescription
var Google\Cloud\Deploy\V1\DeployJobRun
Returns
TypeDescription
$this

getVerifyJobRun

Output only. Information specific to a verify JobRun.

Returns
TypeDescription
Google\Cloud\Deploy\V1\VerifyJobRun|null

hasVerifyJobRun

setVerifyJobRun

Output only. Information specific to a verify JobRun.

Parameter
NameDescription
var Google\Cloud\Deploy\V1\VerifyJobRun
Returns
TypeDescription
$this

getCreateChildRolloutJobRun

Output only. Information specific to a createChildRollout JobRun.

Returns
TypeDescription
Google\Cloud\Deploy\V1\CreateChildRolloutJobRun|null

hasCreateChildRolloutJobRun

setCreateChildRolloutJobRun

Output only. Information specific to a createChildRollout JobRun.

Parameter
NameDescription
var Google\Cloud\Deploy\V1\CreateChildRolloutJobRun
Returns
TypeDescription
$this

getAdvanceChildRolloutJobRun

Output only. Information specific to an advanceChildRollout JobRun

Returns
TypeDescription
Google\Cloud\Deploy\V1\AdvanceChildRolloutJobRun|null

hasAdvanceChildRolloutJobRun

setAdvanceChildRolloutJobRun

Output only. Information specific to an advanceChildRollout JobRun

Parameter
NameDescription
var Google\Cloud\Deploy\V1\AdvanceChildRolloutJobRun
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getJobRun

Returns
TypeDescription
string