Google Cloud Deploy V1 Client - Class Job (1.5.1)

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

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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`	`DeployJob` Output only. A deploy Job.
`↳ verify_job`	`VerifyJob` Output only. A verify Job.
`↳ predeploy_job`	`PredeployJob` Output only. A predeploy Job.
`↳ postdeploy_job`	`PostdeployJob` Output only. A postdeploy Job.
`↳ create_child_rollout_job`	`CreateChildRolloutJob` Output only. A createChildRollout Job.
`↳ advance_child_rollout_job`	`AdvanceChildRolloutJob` Output only. An advanceChildRollout Job.

getId

Output only. The ID of the Job.

Returns
Type	Description
`string`

setId

Output only. The ID of the Job.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getState

Output only. The current state of the Job.

Returns
Type	Description
`int`

setState

Output only. The current state of the Job.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getSkipMessage

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

Returns
Type	Description
`string`

setSkipMessage

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getJobRun

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

Returns
Type	Description
`string`

setJobRun

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDeployJob

Output only. A deploy Job.

Returns
Type	Description
`DeployJob\|null`

hasDeployJob

setDeployJob

Output only. A deploy Job.

Parameter
Name	Description
`var`	`DeployJob`

Returns
Type	Description
`$this`

getVerifyJob

Output only. A verify Job.

Returns
Type	Description
`VerifyJob\|null`

hasVerifyJob

setVerifyJob

Output only. A verify Job.

Parameter
Name	Description
`var`	`VerifyJob`

Returns
Type	Description
`$this`

getPredeployJob

Output only. A predeploy Job.

Returns
Type	Description
`PredeployJob\|null`

hasPredeployJob

setPredeployJob

Output only. A predeploy Job.

Parameter
Name	Description
`var`	`PredeployJob`

Returns
Type	Description
`$this`

getPostdeployJob

Output only. A postdeploy Job.

Returns
Type	Description
`PostdeployJob\|null`

hasPostdeployJob

setPostdeployJob

Output only. A postdeploy Job.

Parameter
Name	Description
`var`	`PostdeployJob`

Returns
Type	Description
`$this`

getCreateChildRolloutJob

Output only. A createChildRollout Job.

Returns
Type	Description
`CreateChildRolloutJob\|null`

hasCreateChildRolloutJob

setCreateChildRolloutJob

Output only. A createChildRollout Job.

Parameter
Name	Description
`var`	`CreateChildRolloutJob`

Returns
Type	Description
`$this`

getAdvanceChildRolloutJob

Output only. An advanceChildRollout Job.

Returns
Type	Description
`AdvanceChildRolloutJob\|null`

hasAdvanceChildRolloutJob

setAdvanceChildRolloutJob

Output only. An advanceChildRollout Job.

Parameter
Name	Description
`var`	`AdvanceChildRolloutJob`

Returns
Type	Description
`$this`

getJobType

Returns
Type	Description
`string`