Google Cloud Deploy V1 Client - Class IgnoreJobRequest (1.3.0)

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

The request object used by IgnoreJob.

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

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ rollout string

Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

↳ phase_id string

Required. The phase ID the Job to ignore belongs to.

↳ job_id string

Required. The job ID for the Job to ignore.

↳ override_deploy_policy array

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

getRollout

Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Returns
Type Description
string

setRollout

Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPhaseId

Required. The phase ID the Job to ignore belongs to.

Returns
Type Description
string

setPhaseId

Required. The phase ID the Job to ignore belongs to.

Parameter
Name Description
var string
Returns
Type Description
$this

getJobId

Required. The job ID for the Job to ignore.

Returns
Type Description
string

setJobId

Required. The job ID for the Job to ignore.

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

Parameters
Name Description
rollout string

Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}. Please see Google\Cloud\Deploy\V1\CloudDeployClient::rolloutName() for help formatting this field.

phaseId string

Required. The phase ID the Job to ignore belongs to.

jobId string

Required. The job ID for the Job to ignore.

Returns
Type Description
Google\Cloud\Deploy\V1\IgnoreJobRequest