Google Cloud Deploy V1 Client - Class TerminateJobRunRequest (1.2.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

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__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}.
↳ override_deploy_policy array

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

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

getOverrideDeployPolicy

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setOverrideDeployPolicy

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

Parameter
Name Description
var string[]
Returns
Type Description
$this

static::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 Google\Cloud\Deploy\V1\CloudDeployClient::jobRunName() for help formatting this field.
Returns
Type Description
Google\Cloud\Deploy\V1\TerminateJobRunRequest