Google Cloud Deploy V1 Client - Class AdvanceRolloutRequest (1.4.0)

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

The request object used by AdvanceRollout.

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

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 Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

↳ phase_id string

Required. The phase ID to advance the Rollout to.

↳ override_deploy_policy array

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

getName

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

Returns
Type Description
string

setName

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 to advance the Rollout to.

Returns
Type Description
string

setPhaseId

Required. The phase ID to advance the Rollout to.

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
name string

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

phaseId string

Required. The phase ID to advance the Rollout to.

Returns
Type Description
AdvanceRolloutRequest