Class DeleteInstanceRequest.Builder (0.72.0)

public static final class DeleteInstanceRequest.Builder extends GeneratedMessage.Builder<DeleteInstanceRequest.Builder> implements DeleteInstanceRequestOrBuilder

Message for deleting a Instance

Protobuf type google.cloud.alloydb.v1alpha.DeleteInstanceRequest

Static Methods

getDescriptor()

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

Methods

build()

public DeleteInstanceRequest build()
Returns
Type Description
DeleteInstanceRequest

buildPartial()

public DeleteInstanceRequest buildPartial()
Returns
Type Description
DeleteInstanceRequest

clear()

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

clearEtag()

public DeleteInstanceRequest.Builder clearEtag()

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

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

Returns
Type Description
DeleteInstanceRequest.Builder

This builder for chaining.

clearName()

public DeleteInstanceRequest.Builder clearName()

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

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

Returns
Type Description
DeleteInstanceRequest.Builder

This builder for chaining.

clearRequestId()

public DeleteInstanceRequest.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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since 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 the original operation with the same request ID was received, and if so, ignores 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
Type Description
DeleteInstanceRequest.Builder

This builder for chaining.

clearValidateOnly()

public DeleteInstanceRequest.Builder clearValidateOnly()

Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.

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

Returns
Type Description
DeleteInstanceRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public DeleteInstanceRequest getDefaultInstanceForType()
Returns
Type Description
DeleteInstanceRequest

getDescriptorForType()

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

getEtag()

public String getEtag()

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

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

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

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

Returns
Type Description
ByteString

The bytes for etag.

getName()

public String getName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Returns
Type Description
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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since 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 the original operation with the same request ID was received, and if so, ignores 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
Type Description
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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since 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 the original operation with the same request ID was received, and if so, ignores 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
Type Description
ByteString

The bytes for requestId.

getValidateOnly()

public boolean getValidateOnly()

Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.

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

Returns
Type Description
boolean

The validateOnly.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DeleteInstanceRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setEtag(String value)

public DeleteInstanceRequest.Builder setEtag(String value)

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

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

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
DeleteInstanceRequest.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public DeleteInstanceRequest.Builder setEtagBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
DeleteInstanceRequest.Builder

This builder for chaining.

setName(String value)

public DeleteInstanceRequest.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DeleteInstanceRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DeleteInstanceRequest.Builder setNameBytes(ByteString value)

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

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
DeleteInstanceRequest.Builder

This builder for chaining.

setRequestId(String value)

public DeleteInstanceRequest.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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since 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 the original operation with the same request ID was received, and if so, ignores 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
Name Description
value String

The requestId to set.

Returns
Type Description
DeleteInstanceRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public DeleteInstanceRequest.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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since 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 the original operation with the same request ID was received, and if so, ignores 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
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
DeleteInstanceRequest.Builder

This builder for chaining.

setValidateOnly(boolean value)

public DeleteInstanceRequest.Builder setValidateOnly(boolean value)

Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.

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

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
DeleteInstanceRequest.Builder

This builder for chaining.