Google Cloud Deploy V1 Client - Class CreateRolloutRequest (0.8.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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}.

↳ rollout_id string

Required. ID of the Rollout.

↳ rollout Google\Cloud\Deploy\V1\Rollout

Required. The Rollout to create.

↳ 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 Rollout. If empty the Rollout will start at the first phase.

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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getRolloutId

Required. ID of the Rollout.

Returns
TypeDescription
string

setRolloutId

Required. ID of the Rollout.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRollout

Required. The Rollout to create.

Returns
TypeDescription
Google\Cloud\Deploy\V1\Rollout|null

hasRollout

clearRollout

setRollout

Required. The Rollout to create.

Parameter
NameDescription
var Google\Cloud\Deploy\V1\Rollout
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this

getStartingPhaseId

Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

Returns
TypeDescription
string

setStartingPhaseId

Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

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}. Please see Google\Cloud\Deploy\V1\CloudDeployClient::releaseName() for help formatting this field.

rollout Google\Cloud\Deploy\V1\Rollout

Required. The Rollout to create.

rolloutId string

Required. ID of the Rollout.

Returns
TypeDescription
Google\Cloud\Deploy\V1\CreateRolloutRequest