Class DeleteClusterRequest.Builder (0.30.0)

public static final class DeleteClusterRequest.Builder extends GeneratedMessageV3.Builder<DeleteClusterRequest.Builder> implements DeleteClusterRequestOrBuilder

Message for deleting a Cluster

Protobuf type google.cloud.alloydb.v1beta.DeleteClusterRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeleteClusterRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DeleteClusterRequest.Builder
Overrides

build()

public DeleteClusterRequest build()
Returns
TypeDescription
DeleteClusterRequest

buildPartial()

public DeleteClusterRequest buildPartial()
Returns
TypeDescription
DeleteClusterRequest

clear()

public DeleteClusterRequest.Builder clear()
Returns
TypeDescription
DeleteClusterRequest.Builder
Overrides

clearEtag()

public DeleteClusterRequest.Builder clearEtag()

Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DeleteClusterRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DeleteClusterRequest.Builder
Overrides

clearForce()

public DeleteClusterRequest.Builder clearForce()

Optional. Whether to cascade delete child instances for given cluster.

bool force = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

clearName()

public DeleteClusterRequest.Builder clearName()

Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

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

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DeleteClusterRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DeleteClusterRequest.Builder
Overrides

clearRequestId()

public DeleteClusterRequest.Builder clearRequestId()

Optional. An optional 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 after 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).

string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

clearValidateOnly()

public DeleteClusterRequest.Builder clearValidateOnly()

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.

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

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

clone()

public DeleteClusterRequest.Builder clone()
Returns
TypeDescription
DeleteClusterRequest.Builder
Overrides

getDefaultInstanceForType()

public DeleteClusterRequest getDefaultInstanceForType()
Returns
TypeDescription
DeleteClusterRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEtag()

public String getEtag()

Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for etag.

getForce()

public boolean getForce()

Optional. Whether to cascade delete child instances for given cluster.

bool force = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The force.

getName()

public String getName()

Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

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

Returns
TypeDescription
ByteString

The bytes for name.

getRequestId()

public String getRequestId()

Optional. An optional 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 after 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).

string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. An optional 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 after 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).

string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for requestId.

getValidateOnly()

public boolean getValidateOnly()

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.

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

Returns
TypeDescription
boolean

The validateOnly.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DeleteClusterRequest other)

public DeleteClusterRequest.Builder mergeFrom(DeleteClusterRequest other)
Parameter
NameDescription
otherDeleteClusterRequest
Returns
TypeDescription
DeleteClusterRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeleteClusterRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DeleteClusterRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DeleteClusterRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DeleteClusterRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeleteClusterRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DeleteClusterRequest.Builder
Overrides

setEtag(String value)

public DeleteClusterRequest.Builder setEtag(String value)

Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The etag to set.

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public DeleteClusterRequest.Builder setEtagBytes(ByteString value)

Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DeleteClusterRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DeleteClusterRequest.Builder
Overrides

setForce(boolean value)

public DeleteClusterRequest.Builder setForce(boolean value)

Optional. Whether to cascade delete child instances for given cluster.

bool force = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueboolean

The force to set.

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

setName(String value)

public DeleteClusterRequest.Builder setName(String value)

Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DeleteClusterRequest.Builder setNameBytes(ByteString value)

Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DeleteClusterRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DeleteClusterRequest.Builder
Overrides

setRequestId(String value)

public DeleteClusterRequest.Builder setRequestId(String value)

Optional. An optional 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 after 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).

string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The requestId to set.

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public DeleteClusterRequest.Builder setRequestIdBytes(ByteString value)

Optional. An optional 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 after 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).

string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for requestId to set.

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DeleteClusterRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DeleteClusterRequest.Builder
Overrides

setValidateOnly(boolean value)

public DeleteClusterRequest.Builder setValidateOnly(boolean value)

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.

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

Parameter
NameDescription
valueboolean

The validateOnly to set.

Returns
TypeDescription
DeleteClusterRequest.Builder

This builder for chaining.