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}.
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
Google\Cloud\Deploy\V1\CloudDeployClient::rolloutName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Deploy V1 Client - Class AdvanceRolloutRequest (2.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0 (latest)](/php/docs/reference/cloud-deploy/latest/V1.AdvanceRolloutRequest)\n- [1.5.7](/php/docs/reference/cloud-deploy/1.5.7/V1.AdvanceRolloutRequest)\n- [1.4.0](/php/docs/reference/cloud-deploy/1.4.0/V1.AdvanceRolloutRequest)\n- [1.3.0](/php/docs/reference/cloud-deploy/1.3.0/V1.AdvanceRolloutRequest)\n- [1.2.0](/php/docs/reference/cloud-deploy/1.2.0/V1.AdvanceRolloutRequest)\n- [1.1.1](/php/docs/reference/cloud-deploy/1.1.1/V1.AdvanceRolloutRequest)\n- [1.0.0](/php/docs/reference/cloud-deploy/1.0.0/V1.AdvanceRolloutRequest)\n- [0.19.1](/php/docs/reference/cloud-deploy/0.19.1/V1.AdvanceRolloutRequest)\n- [0.18.1](/php/docs/reference/cloud-deploy/0.18.1/V1.AdvanceRolloutRequest)\n- [0.17.0](/php/docs/reference/cloud-deploy/0.17.0/V1.AdvanceRolloutRequest)\n- [0.16.0](/php/docs/reference/cloud-deploy/0.16.0/V1.AdvanceRolloutRequest)\n- [0.15.0](/php/docs/reference/cloud-deploy/0.15.0/V1.AdvanceRolloutRequest)\n- [0.14.0](/php/docs/reference/cloud-deploy/0.14.0/V1.AdvanceRolloutRequest)\n- [0.13.1](/php/docs/reference/cloud-deploy/0.13.1/V1.AdvanceRolloutRequest)\n- [0.12.1](/php/docs/reference/cloud-deploy/0.12.1/V1.AdvanceRolloutRequest)\n- [0.11.1](/php/docs/reference/cloud-deploy/0.11.1/V1.AdvanceRolloutRequest)\n- [0.10.0](/php/docs/reference/cloud-deploy/0.10.0/V1.AdvanceRolloutRequest)\n- [0.9.0](/php/docs/reference/cloud-deploy/0.9.0/V1.AdvanceRolloutRequest)\n- [0.8.0](/php/docs/reference/cloud-deploy/0.8.0/V1.AdvanceRolloutRequest)\n- [0.7.0](/php/docs/reference/cloud-deploy/0.7.0/V1.AdvanceRolloutRequest)\n- [0.6.0](/php/docs/reference/cloud-deploy/0.6.0/V1.AdvanceRolloutRequest)\n- [0.5.0](/php/docs/reference/cloud-deploy/0.5.0/V1.AdvanceRolloutRequest)\n- [0.4.1](/php/docs/reference/cloud-deploy/0.4.1/V1.AdvanceRolloutRequest)\n- [0.3.4](/php/docs/reference/cloud-deploy/0.3.4/V1.AdvanceRolloutRequest) \nReference documentation and code samples for the Google Cloud Deploy V1 Client class AdvanceRolloutRequest.\n\nThe request object used by `AdvanceRollout`.\n\nGenerated from protobuf message `google.cloud.deploy.v1.AdvanceRolloutRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Deploy \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. Name of the Rollout. Format is\n`projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.\n\n### setName\n\nRequired. Name of the Rollout. Format is\n`projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.\n\n### getPhaseId\n\nRequired. The phase ID to advance the `Rollout` to.\n\n### setPhaseId\n\nRequired. The phase ID to advance the `Rollout` to.\n\n### getOverrideDeployPolicy\n\nOptional. Deploy policies to override. Format is\n`projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.\n\n### setOverrideDeployPolicy\n\nOptional. Deploy policies to override. Format is\n`projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.\n\n### static::build"]]