Reference documentation and code samples for the Google Cloud Deploy V1 Client class CreateRolloutRequest.
CreateRolloutRequest is the request object used byCreateRollout.
Generated from protobuf messagegoogle.cloud.deploy.v1.CreateRolloutRequest
Namespace
Google \ Cloud \ Deploy \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent collection in which theRolloutmust be created. The format isprojects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
↳ validate_only
bool
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
↳ override_deploy_policy
array
Optional. Deploy policies to override. Format isprojects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
↳ starting_phase_id
string
Optional. The starting phase ID for theRollout. If empty theRolloutwill start at the first phase.
getParent
Required. The parent collection in which theRolloutmust be created.
The format isprojects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
Returns
Type
Description
string
setParent
Required. The parent collection in which theRolloutmust be created.
The format isprojects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
Optional. A request ID to identify requests. Specify a unique request ID
so that if you must retry your request, the server knows to ignore the
request if it has already been completed. The server guarantees that for
at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request ID,
the server can check if original operation with the same request ID was
received, and if so, will ignore the second request. This prevents clients
from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
Returns
Type
Description
string
setRequestId
Optional. A request ID to identify requests. Specify a unique request ID
so that if you must retry your request, the server knows to ignore the
request if it has already been completed. The server guarantees that for
at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request ID,
the server can check if original operation with the same request ID was
received, and if so, will ignore the second request. This prevents clients
from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getValidateOnly
Optional. If set to true, the request is validated and the user is provided
with an expected result, but no actual change is made.
Returns
Type
Description
bool
setValidateOnly
Optional. If set to true, the request is validated and the user is provided
with an expected result, but no actual change is made.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getOverrideDeployPolicy
Optional. Deploy policies to override. Format isprojects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
Optional. Deploy policies to override. Format isprojects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getStartingPhaseId
Optional. The starting phase ID for theRollout. If empty theRolloutwill start at the first phase.
Returns
Type
Description
string
setStartingPhaseId
Optional. The starting phase ID for theRollout. If empty theRolloutwill start at the first phase.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameters
Name
Description
parent
string
Required. The parent collection in which theRolloutmust be created.
The format isprojects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}. Please seeGoogle\Cloud\Deploy\V1\CloudDeployClient::releaseName()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-09-04 UTC."],[],[],null,["# Google Cloud Deploy V1 Client - Class CreateRolloutRequest (2.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0 (latest)](/php/docs/reference/cloud-deploy/latest/V1.CreateRolloutRequest)\n- [1.5.7](/php/docs/reference/cloud-deploy/1.5.7/V1.CreateRolloutRequest)\n- [1.4.0](/php/docs/reference/cloud-deploy/1.4.0/V1.CreateRolloutRequest)\n- [1.3.0](/php/docs/reference/cloud-deploy/1.3.0/V1.CreateRolloutRequest)\n- [1.2.0](/php/docs/reference/cloud-deploy/1.2.0/V1.CreateRolloutRequest)\n- [1.1.1](/php/docs/reference/cloud-deploy/1.1.1/V1.CreateRolloutRequest)\n- [1.0.0](/php/docs/reference/cloud-deploy/1.0.0/V1.CreateRolloutRequest)\n- [0.19.1](/php/docs/reference/cloud-deploy/0.19.1/V1.CreateRolloutRequest)\n- [0.18.1](/php/docs/reference/cloud-deploy/0.18.1/V1.CreateRolloutRequest)\n- [0.17.0](/php/docs/reference/cloud-deploy/0.17.0/V1.CreateRolloutRequest)\n- [0.16.0](/php/docs/reference/cloud-deploy/0.16.0/V1.CreateRolloutRequest)\n- [0.15.0](/php/docs/reference/cloud-deploy/0.15.0/V1.CreateRolloutRequest)\n- [0.14.0](/php/docs/reference/cloud-deploy/0.14.0/V1.CreateRolloutRequest)\n- [0.13.1](/php/docs/reference/cloud-deploy/0.13.1/V1.CreateRolloutRequest)\n- [0.12.1](/php/docs/reference/cloud-deploy/0.12.1/V1.CreateRolloutRequest)\n- [0.11.1](/php/docs/reference/cloud-deploy/0.11.1/V1.CreateRolloutRequest)\n- [0.10.0](/php/docs/reference/cloud-deploy/0.10.0/V1.CreateRolloutRequest)\n- [0.9.0](/php/docs/reference/cloud-deploy/0.9.0/V1.CreateRolloutRequest)\n- [0.8.0](/php/docs/reference/cloud-deploy/0.8.0/V1.CreateRolloutRequest)\n- [0.7.0](/php/docs/reference/cloud-deploy/0.7.0/V1.CreateRolloutRequest)\n- [0.6.0](/php/docs/reference/cloud-deploy/0.6.0/V1.CreateRolloutRequest)\n- [0.5.0](/php/docs/reference/cloud-deploy/0.5.0/V1.CreateRolloutRequest)\n- [0.4.1](/php/docs/reference/cloud-deploy/0.4.1/V1.CreateRolloutRequest)\n- [0.3.4](/php/docs/reference/cloud-deploy/0.3.4/V1.CreateRolloutRequest) \nReference documentation and code samples for the Google Cloud Deploy V1 Client class CreateRolloutRequest.\n\nCreateRolloutRequest is the request object used by `CreateRollout`.\n\nGenerated from protobuf message `google.cloud.deploy.v1.CreateRolloutRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Deploy \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent collection in which the `Rollout` must be created.\n\nThe format is\n`projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.\n\n### setParent\n\nRequired. The parent collection in which the `Rollout` must be created.\n\nThe format is\n`projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.\n\n### getRolloutId\n\nRequired. ID of the `Rollout`.\n\n### setRolloutId\n\nRequired. ID of the `Rollout`.\n\n### getRollout\n\nRequired. The `Rollout` to create.\n\n### hasRollout\n\n### clearRollout\n\n### setRollout\n\nRequired. The `Rollout` to create.\n\n### getRequestId\n\nOptional. A request ID to identify requests. Specify a unique request ID\nso that if you must retry your request, the server knows to ignore the\nrequest if it has already been completed. The server guarantees that for\nat least 60 minutes after the first request.\n\nFor example, consider a situation where you make an initial request and the\nrequest times out. If you make the request again with the same request ID,\nthe server can check if original operation with the same request ID was\nreceived, and if so, will ignore the second request. This prevents clients\nfrom accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### setRequestId\n\nOptional. A request ID to identify requests. Specify a unique request ID\nso that if you must retry your request, the server knows to ignore the\nrequest if it has already been completed. The server guarantees that for\nat least 60 minutes after the first request.\n\nFor example, consider a situation where you make an initial request and the\nrequest times out. If you make the request again with the same request ID,\nthe server can check if original operation with the same request ID was\nreceived, and if so, will ignore the second request. This prevents clients\nfrom accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### getValidateOnly\n\nOptional. If set to true, the request is validated and the user is provided\nwith an expected result, but no actual change is made.\n\n### setValidateOnly\n\nOptional. If set to true, the request is validated and the user is provided\nwith an expected result, but no actual change is made.\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### getStartingPhaseId\n\nOptional. The starting phase ID for the `Rollout`. If empty the `Rollout`\nwill start at the first phase.\n\n### setStartingPhaseId\n\nOptional. The starting phase ID for the `Rollout`. If empty the `Rollout`\nwill start at the first phase.\n\n### static::build"]]
