Google Cloud Deploy V1 Client - Class TerminateJobRunRequest (0.6.0)

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

The request object used by TerminateJobRun.

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

Methods

build

Parameter
Name Description
name string

Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}. Please see {@see \Google\Cloud\Deploy\V1\CloudDeployClient::jobRunName()} for help formatting this field.
Returns
Type Description
Google\Cloud\Deploy\V1\TerminateJobRunRequest

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

getName

Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

Returns
Type Description
string

setName

Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

Parameter
Name Description
var string
Returns
Type Description
$this