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 \ V1Methods
__construct
Constructor.
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
↳ 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}
.
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}
.
var
string
$this
getTargetId
Required. ID of the Target
that is being rolled back.
string
setTargetId
Required. ID of the Target
that is being rolled back.
var
string
$this
getRolloutId
Required. ID of the rollback Rollout
to create.
string
setRolloutId
Required. ID of the rollback Rollout
to create.
var
string
$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
.
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
.
var
string
$this
getRolloutToRollBack
Optional. If provided, this must be the latest Rollout
that is on the Target
.
string
setRolloutToRollBack
Optional. If provided, this must be the latest Rollout
that is on the Target
.
var
string
$this
getRollbackConfig
Optional. Configs for the rollback Rollout
.
hasRollbackConfig
clearRollbackConfig
setRollbackConfig
Optional. Configs for the rollback Rollout
.
$this
getValidateOnly
Optional. If set to true, the request is validated and the user is provided
with a RollbackTargetResponse
.
bool
setValidateOnly
Optional. If set to true, the request is validated and the user is provided
with a RollbackTargetResponse
.
var
bool
$this
getOverrideDeployPolicy
Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deploy_policy}
.
setOverrideDeployPolicy
Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deploy_policy}
.
var
string[]
$this
static::build
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.
