Class RollbackTargetRequest.Builder (1.81.0)

public static final class RollbackTargetRequest.Builder extends GeneratedMessage.Builder<RollbackTargetRequest.Builder> implements RollbackTargetRequestOrBuilder

The request object for RollbackTarget.

Protobuf type google.cloud.deploy.v1.RollbackTargetRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllOverrideDeployPolicy(Iterable<String> values)

public RollbackTargetRequest.Builder addAllOverrideDeployPolicy(Iterable<String> values)

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

repeated string override_deploy_policy = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The overrideDeployPolicy to add.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

addOverrideDeployPolicy(String value)

public RollbackTargetRequest.Builder addOverrideDeployPolicy(String value)

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

repeated string override_deploy_policy = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The overrideDeployPolicy to add.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

addOverrideDeployPolicyBytes(ByteString value)

public RollbackTargetRequest.Builder addOverrideDeployPolicyBytes(ByteString value)

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

repeated string override_deploy_policy = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the overrideDeployPolicy to add.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

build()

public RollbackTargetRequest build()
Returns
Type Description
RollbackTargetRequest

buildPartial()

public RollbackTargetRequest buildPartial()
Returns
Type Description
RollbackTargetRequest

clear()

public RollbackTargetRequest.Builder clear()
Returns
Type Description
RollbackTargetRequest.Builder
Overrides

clearName()

public RollbackTargetRequest.Builder clearName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

clearOverrideDeployPolicy()

public RollbackTargetRequest.Builder clearOverrideDeployPolicy()

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

repeated string override_deploy_policy = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

clearReleaseId()

public RollbackTargetRequest.Builder clearReleaseId()

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 release_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

clearRollbackConfig()

public RollbackTargetRequest.Builder clearRollbackConfig()

Optional. Configs for the rollback Rollout.

.google.cloud.deploy.v1.RollbackTargetConfig rollback_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RollbackTargetRequest.Builder

clearRolloutId()

public RollbackTargetRequest.Builder clearRolloutId()

Required. ID of the rollback Rollout to create.

string rollout_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

clearRolloutToRollBack()

public RollbackTargetRequest.Builder clearRolloutToRollBack()

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

string rollout_to_roll_back = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

clearTargetId()

public RollbackTargetRequest.Builder clearTargetId()

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

string target_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

clearValidateOnly()

public RollbackTargetRequest.Builder clearValidateOnly()

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

bool validate_only = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public RollbackTargetRequest getDefaultInstanceForType()
Returns
Type Description
RollbackTargetRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String 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 name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getOverrideDeployPolicy(int index)

public String getOverrideDeployPolicy(int index)

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

repeated string override_deploy_policy = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The overrideDeployPolicy at the given index.

getOverrideDeployPolicyBytes(int index)

public ByteString getOverrideDeployPolicyBytes(int index)

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

repeated string override_deploy_policy = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the overrideDeployPolicy at the given index.

getOverrideDeployPolicyCount()

public int getOverrideDeployPolicyCount()

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

repeated string override_deploy_policy = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of overrideDeployPolicy.

getOverrideDeployPolicyList()

public ProtocolStringList getOverrideDeployPolicyList()

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

repeated string override_deploy_policy = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the overrideDeployPolicy.

getReleaseId()

public String 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 release_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The releaseId.

getReleaseIdBytes()

public ByteString getReleaseIdBytes()

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 release_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for releaseId.

getRollbackConfig()

public RollbackTargetConfig getRollbackConfig()

Optional. Configs for the rollback Rollout.

.google.cloud.deploy.v1.RollbackTargetConfig rollback_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RollbackTargetConfig

The rollbackConfig.

getRollbackConfigBuilder()

public RollbackTargetConfig.Builder getRollbackConfigBuilder()

Optional. Configs for the rollback Rollout.

.google.cloud.deploy.v1.RollbackTargetConfig rollback_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RollbackTargetConfig.Builder

getRollbackConfigOrBuilder()

public RollbackTargetConfigOrBuilder getRollbackConfigOrBuilder()

Optional. Configs for the rollback Rollout.

.google.cloud.deploy.v1.RollbackTargetConfig rollback_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RollbackTargetConfigOrBuilder

getRolloutId()

public String getRolloutId()

Required. ID of the rollback Rollout to create.

string rollout_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The rolloutId.

getRolloutIdBytes()

public ByteString getRolloutIdBytes()

Required. ID of the rollback Rollout to create.

string rollout_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for rolloutId.

getRolloutToRollBack()

public String getRolloutToRollBack()

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

string rollout_to_roll_back = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The rolloutToRollBack.

getRolloutToRollBackBytes()

public ByteString getRolloutToRollBackBytes()

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

string rollout_to_roll_back = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for rolloutToRollBack.

getTargetId()

public String getTargetId()

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

string target_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The targetId.

getTargetIdBytes()

public ByteString getTargetIdBytes()

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

string target_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for targetId.

getValidateOnly()

public boolean getValidateOnly()

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

bool validate_only = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The validateOnly.

hasRollbackConfig()

public boolean hasRollbackConfig()

Optional. Configs for the rollback Rollout.

.google.cloud.deploy.v1.RollbackTargetConfig rollback_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rollbackConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RollbackTargetRequest other)

public RollbackTargetRequest.Builder mergeFrom(RollbackTargetRequest other)
Parameter
Name Description
other RollbackTargetRequest
Returns
Type Description
RollbackTargetRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RollbackTargetRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RollbackTargetRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RollbackTargetRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RollbackTargetRequest.Builder
Overrides

mergeRollbackConfig(RollbackTargetConfig value)

public RollbackTargetRequest.Builder mergeRollbackConfig(RollbackTargetConfig value)

Optional. Configs for the rollback Rollout.

.google.cloud.deploy.v1.RollbackTargetConfig rollback_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value RollbackTargetConfig
Returns
Type Description
RollbackTargetRequest.Builder

setName(String value)

public RollbackTargetRequest.Builder setName(String value)

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RollbackTargetRequest.Builder setNameBytes(ByteString value)

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

setOverrideDeployPolicy(int index, String value)

public RollbackTargetRequest.Builder setOverrideDeployPolicy(int index, String value)

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

repeated string override_deploy_policy = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The overrideDeployPolicy to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

setReleaseId(String value)

public RollbackTargetRequest.Builder setReleaseId(String value)

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 release_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The releaseId to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

setReleaseIdBytes(ByteString value)

public RollbackTargetRequest.Builder setReleaseIdBytes(ByteString value)

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 release_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for releaseId to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

setRollbackConfig(RollbackTargetConfig value)

public RollbackTargetRequest.Builder setRollbackConfig(RollbackTargetConfig value)

Optional. Configs for the rollback Rollout.

.google.cloud.deploy.v1.RollbackTargetConfig rollback_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value RollbackTargetConfig
Returns
Type Description
RollbackTargetRequest.Builder

setRollbackConfig(RollbackTargetConfig.Builder builderForValue)

public RollbackTargetRequest.Builder setRollbackConfig(RollbackTargetConfig.Builder builderForValue)

Optional. Configs for the rollback Rollout.

.google.cloud.deploy.v1.RollbackTargetConfig rollback_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue RollbackTargetConfig.Builder
Returns
Type Description
RollbackTargetRequest.Builder

setRolloutId(String value)

public RollbackTargetRequest.Builder setRolloutId(String value)

Required. ID of the rollback Rollout to create.

string rollout_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The rolloutId to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

setRolloutIdBytes(ByteString value)

public RollbackTargetRequest.Builder setRolloutIdBytes(ByteString value)

Required. ID of the rollback Rollout to create.

string rollout_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for rolloutId to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

setRolloutToRollBack(String value)

public RollbackTargetRequest.Builder setRolloutToRollBack(String value)

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

string rollout_to_roll_back = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The rolloutToRollBack to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

setRolloutToRollBackBytes(ByteString value)

public RollbackTargetRequest.Builder setRolloutToRollBackBytes(ByteString value)

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

string rollout_to_roll_back = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for rolloutToRollBack to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

setTargetId(String value)

public RollbackTargetRequest.Builder setTargetId(String value)

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

string target_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The targetId to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

setTargetIdBytes(ByteString value)

public RollbackTargetRequest.Builder setTargetIdBytes(ByteString value)

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

string target_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for targetId to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.

setValidateOnly(boolean value)

public RollbackTargetRequest.Builder setValidateOnly(boolean value)

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

bool validate_only = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
RollbackTargetRequest.Builder

This builder for chaining.