Google Cloud Deploy V1 Client - Class RollbackTargetRequest (0.17.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
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The DeliveryPipeline for which the rollback Rollout should be created. Format should be 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 Google\Cloud\Deploy\V1\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.

getName

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

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTargetId

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

Returns
TypeDescription
string

setTargetId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRolloutId

Required. ID of the rollback Rollout to create.

Returns
TypeDescription
string

setRolloutId

Required. ID of the rollback Rollout to create.

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

getRolloutToRollBack

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

Returns
TypeDescription
string

setRolloutToRollBack

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRollbackConfig

Optional. Configs for the rollback Rollout.

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

hasRollbackConfig

clearRollbackConfig

setRollbackConfig

Optional. Configs for the rollback Rollout.

Parameter
NameDescription
var Google\Cloud\Deploy\V1\RollbackTargetConfig
Returns
TypeDescription
$this

getValidateOnly

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

Returns
TypeDescription
bool

setValidateOnly

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
name string

Required. The DeliveryPipeline for which the rollback Rollout should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}. Please see Google\Cloud\Deploy\V1\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
TypeDescription
Google\Cloud\Deploy\V1\RollbackTargetRequest