Class PromoteClusterRequest.Builder (0.17.0)

public static final class PromoteClusterRequest.Builder extends GeneratedMessageV3.Builder<PromoteClusterRequest.Builder> implements PromoteClusterRequestOrBuilder

Message for promoting a Cluster

Protobuf type google.cloud.alloydb.v1beta.PromoteClusterRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PromoteClusterRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PromoteClusterRequest.Builder
Overrides

build()

public PromoteClusterRequest build()
Returns
Type Description
PromoteClusterRequest

buildPartial()

public PromoteClusterRequest buildPartial()
Returns
Type Description
PromoteClusterRequest

clear()

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

clearEtag()

public PromoteClusterRequest.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
PromoteClusterRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PromoteClusterRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PromoteClusterRequest.Builder
Overrides

clearName()

public PromoteClusterRequest.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
PromoteClusterRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PromoteClusterRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PromoteClusterRequest.Builder
Overrides

clearRequestId()

public PromoteClusterRequest.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
PromoteClusterRequest.Builder

This builder for chaining.

clearValidateOnly()

public PromoteClusterRequest.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
PromoteClusterRequest.Builder

This builder for chaining.

clone()

public PromoteClusterRequest.Builder clone()
Returns
Type Description
PromoteClusterRequest.Builder
Overrides

getDefaultInstanceForType()

public PromoteClusterRequest getDefaultInstanceForType()
Returns
Type Description
PromoteClusterRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
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.

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
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PromoteClusterRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PromoteClusterRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PromoteClusterRequest.Builder
Overrides

setEtag(String value)

public PromoteClusterRequest.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 String

The etag to set.

Returns
Type Description
PromoteClusterRequest.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public PromoteClusterRequest.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 ByteString

The bytes for etag to set.

Returns
Type Description
PromoteClusterRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PromoteClusterRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PromoteClusterRequest.Builder
Overrides

setName(String value)

public PromoteClusterRequest.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 String

The name to set.

Returns
Type Description
PromoteClusterRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public PromoteClusterRequest.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 ByteString

The bytes for name to set.

Returns
Type Description
PromoteClusterRequest.Builder

This builder for chaining.

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

public PromoteClusterRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PromoteClusterRequest.Builder
Overrides

setRequestId(String value)

public PromoteClusterRequest.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 String

The requestId to set.

Returns
Type Description
PromoteClusterRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public PromoteClusterRequest.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 ByteString

The bytes for requestId to set.

Returns
Type Description
PromoteClusterRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PromoteClusterRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PromoteClusterRequest.Builder
Overrides

setValidateOnly(boolean value)

public PromoteClusterRequest.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 boolean

The validateOnly to set.

Returns
Type Description
PromoteClusterRequest.Builder

This builder for chaining.