Reference documentation and code samples for the Google Cloud Deploy V1 Client class CreateRolloutRequest.
CreateRolloutRequest is the request object used by CreateRollout.
Generated from protobuf message google.cloud.deploy.v1.CreateRolloutRequest
Methods
build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent collection in which the |
rollout |
Google\Cloud\Deploy\V1\Rollout
Required. The |
rolloutId |
string
Required. ID of the |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\CreateRolloutRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent collection in which the |
↳ rollout_id |
string
Required. ID of the |
↳ rollout |
Google\Cloud\Deploy\V1\Rollout
Required. The |
↳ request_id |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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. |
↳ starting_phase_id |
string
Optional. The starting phase ID for the |
getParent
Required. The parent collection in which the Rollout should be created.
Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The parent collection in which the Rollout should be created.
Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRolloutId
Required. ID of the Rollout.
| Returns | |
|---|---|
| Type | Description |
string | |
setRolloutId
Required. ID of the Rollout.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRollout
Required. The Rollout to create.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\Rollout|null | |
hasRollout
clearRollout
setRollout
Required. The Rollout to create.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Deploy\V1\Rollout
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestId
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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 | |
getStartingPhaseId
Optional. The starting phase ID for the Rollout. If empty the Rollout
will start at the first phase.
| Returns | |
|---|---|
| Type | Description |
string | |
setStartingPhaseId
Optional. The starting phase ID for the Rollout. If empty the Rollout
will start at the first phase.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |