Google Cloud Deploy V1 Client - Class RollbackTargetRequest (1.4.0)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class RollbackTargetRequest.

The request object for RollbackTarget.

Generated from protobuf message google.cloud.deploy.v1.RollbackTargetRequest

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The `DeliveryPipeline` for which the rollback `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
`↳ target_id`	`string` Required. ID of the `Target` that is being rolled back.
`↳ rollout_id`	`string` Required. ID of the rollback `Rollout` to create.
`↳ release_id`	`string` Optional. ID of the `Release` to roll back to. If this isn't specified, the previous successful `Rollout` to the specified target will be used to determine the `Release`.
`↳ rollout_to_roll_back`	`string` Optional. If provided, this must be the latest `Rollout` that is on the `Target`.
`↳ rollback_config`	`RollbackTargetConfig` Optional. Configs for the rollback `Rollout`.
`↳ validate_only`	`bool` Optional. If set to true, the request is validated and the user is provided with a `RollbackTargetResponse`.
`↳ override_deploy_policy`	`array` Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deploy_policy}`.

getName

Required. The DeliveryPipeline for which the rollback Rollout must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Returns
Type	Description
`string`

setName

Required. The DeliveryPipeline for which the rollback Rollout must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTargetId

Required. ID of the Target that is being rolled back.

Returns
Type	Description
`string`

setTargetId

Required. ID of the Target that is being rolled back.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRolloutId

Required. ID of the rollback Rollout to create.

Returns
Type	Description
`string`

setRolloutId

Required. ID of the rollback Rollout to create.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReleaseId

Optional. ID of the Release to roll back to. If this isn't specified, the previous successful Rollout to the specified target will be used to determine the Release.

Returns
Type	Description
`string`

setReleaseId

Optional. ID of the Release to roll back to. If this isn't specified, the previous successful Rollout to the specified target will be used to determine the Release.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRolloutToRollBack

Optional. If provided, this must be the latest Rollout that is on the Target.

Returns
Type	Description
`string`

setRolloutToRollBack

Optional. If provided, this must be the latest Rollout that is on the Target.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRollbackConfig

Optional. Configs for the rollback Rollout.

Returns
Type	Description
`RollbackTargetConfig\|null`

hasRollbackConfig

clearRollbackConfig

setRollbackConfig

Optional. Configs for the rollback Rollout.

Parameter
Name	Description
`var`	`RollbackTargetConfig`

Returns
Type	Description
`$this`

getValidateOnly

Optional. If set to true, the request is validated and the user is provided with a RollbackTargetResponse.

Returns
Type	Description
`bool`

setValidateOnly

Optional. If set to true, the request is validated and the user is provided with a RollbackTargetResponse.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getOverrideDeployPolicy

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deploy_policy}.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setOverrideDeployPolicy

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deploy_policy}.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`name`	`string` Required. The `DeliveryPipeline` for which the rollback `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. Please see CloudDeployClient::deliveryPipelineName() for help formatting this field.
`targetId`	`string` Required. ID of the `Target` that is being rolled back.
`rolloutId`	`string` Required. ID of the rollback `Rollout` to create.

Returns
Type	Description
`RollbackTargetRequest`