Google Cloud Deploy V1 Client - Class Job (0.5.0)

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

Job represents an operation for a Rollout.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ id string

Output only. The ID of the Job.

↳ state int

Output only. The current state of the Job.

↳ skip_message string

Output only. Additional information on why the Job was skipped, if available.

↳ job_run string

Output only. The name of the JobRun responsible for the most recent invocation of this Job.

↳ deploy_job Google\Cloud\Deploy\V1\DeployJob

Output only. A deploy Job.

↳ verify_job Google\Cloud\Deploy\V1\VerifyJob

Output only. A verify Job.

↳ create_child_rollout_job Google\Cloud\Deploy\V1\CreateChildRolloutJob

Output only. A createChildRollout Job.

↳ advance_child_rollout_job Google\Cloud\Deploy\V1\AdvanceChildRolloutJob

Output only. An advanceChildRollout Job.

getId

Output only. The ID of the Job.

Returns
TypeDescription
string

setId

Output only. The ID of the Job.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The current state of the Job.

Returns
TypeDescription
int

setState

Output only. The current state of the Job.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSkipMessage

Output only. Additional information on why the Job was skipped, if available.

Returns
TypeDescription
string

setSkipMessage

Output only. Additional information on why the Job was skipped, if available.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJobRun

Output only. The name of the JobRun responsible for the most recent invocation of this Job.

Returns
TypeDescription
string

setJobRun

Output only. The name of the JobRun responsible for the most recent invocation of this Job.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDeployJob

Output only. A deploy Job.

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

hasDeployJob

setDeployJob

Output only. A deploy Job.

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

getVerifyJob

Output only. A verify Job.

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

hasVerifyJob

setVerifyJob

Output only. A verify Job.

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

getCreateChildRolloutJob

Output only. A createChildRollout Job.

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

hasCreateChildRolloutJob

setCreateChildRolloutJob

Output only. A createChildRollout Job.

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

getAdvanceChildRolloutJob

Output only. An advanceChildRollout Job.

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

hasAdvanceChildRolloutJob

setAdvanceChildRolloutJob

Output only. An advanceChildRollout Job.

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

getJobType

Returns
TypeDescription
string