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
Namespace
Google \ Cloud \ Deploy \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent collection in which the Rollout
must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}
.
↳ rollout_id
string
Required. ID of the Rollout
.
↳ rollout
↳ 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 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.
↳ starting_phase_id
string
Optional. The starting phase ID for the Rollout
. If empty the Rollout
will start at the first phase.
getParent
Required. The parent collection in which the Rollout
must be created.
The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}
.
string
setParent
Required. The parent collection in which the Rollout
must be created.
The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}
.
var
string
$this
getRolloutId
Required. ID of the Rollout
.
string
setRolloutId
Required. ID of the Rollout
.
var
string
$this
getRollout
Required. The Rollout
to create.
hasRollout
clearRollout
setRollout
Required. The Rollout
to create.
$this
getRequestId
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).
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).
var
string
$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.
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.
var
bool
$this
getStartingPhaseId
Optional. The starting phase ID for the Rollout
. If empty the Rollout
will start at the first phase.
string
setStartingPhaseId
Optional. The starting phase ID for the Rollout
. If empty the Rollout
will start at the first phase.
var
string
$this
static::build
parent
string
Required. The parent collection in which the Rollout
must be created.
The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}
. Please see Google\Cloud\Deploy\V1\CloudDeployClient::releaseName()
for help formatting this field.
rollout
rolloutId
string
Required. ID of the Rollout
.
