public static final class DeleteClusterRequest.Builder extends GeneratedMessageV3.Builder<DeleteClusterRequest.Builder> implements DeleteClusterRequestOrBuilderMessage for deleting a Cluster
Protobuf type google.cloud.alloydb.v1.DeleteClusterRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DeleteClusterRequest.BuilderImplements
DeleteClusterRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DeleteClusterRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
build()
public DeleteClusterRequest build()| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest |
|
buildPartial()
public DeleteClusterRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest |
|
clear()
public DeleteClusterRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
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 | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public DeleteClusterRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
clearForce()
public DeleteClusterRequest.Builder clearForce()Optional. Whether to cascade delete child instances for given cluster.
bool force = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public DeleteClusterRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
This builder for chaining. |
clone()
public DeleteClusterRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
getDefaultInstanceForType()
public DeleteClusterRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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 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 | |
|---|---|
| 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 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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
The validateOnly. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(DeleteClusterRequest other)
public DeleteClusterRequest.Builder mergeFrom(DeleteClusterRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
DeleteClusterRequest |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DeleteClusterRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DeleteClusterRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DeleteClusterRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
StringThe etag to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for etag to set. |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public DeleteClusterRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
booleanThe force to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
StringThe requestId to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for requestId to set. |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final DeleteClusterRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
booleanThe validateOnly to set. |
| Returns | |
|---|---|
| Type | Description |
DeleteClusterRequest.Builder |
This builder for chaining. |