Class RestoreClusterRequest.Builder (0.44.0)

public static final class RestoreClusterRequest.Builder extends GeneratedMessageV3.Builder<RestoreClusterRequest.Builder> implements RestoreClusterRequestOrBuilder

Message for restoring a Cluster from a backup or another cluster at a given point in time.

Protobuf type google.cloud.alloydb.v1.RestoreClusterRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RestoreClusterRequest build()
Returns
Type Description
RestoreClusterRequest

buildPartial()

public RestoreClusterRequest buildPartial()
Returns
Type Description
RestoreClusterRequest

clear()

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

clearBackupSource()

public RestoreClusterRequest.Builder clearBackupSource()

Backup source.

.google.cloud.alloydb.v1.BackupSource backup_source = 4;

Returns
Type Description
RestoreClusterRequest.Builder

clearCluster()

public RestoreClusterRequest.Builder clearCluster()

Required. The resource being created

.google.cloud.alloydb.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RestoreClusterRequest.Builder

clearClusterId()

public RestoreClusterRequest.Builder clearClusterId()

Required. ID of the requesting object.

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

Returns
Type Description
RestoreClusterRequest.Builder

This builder for chaining.

clearContinuousBackupSource()

public RestoreClusterRequest.Builder clearContinuousBackupSource()

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.

.google.cloud.alloydb.v1.ContinuousBackupSource continuous_backup_source = 8;

Returns
Type Description
RestoreClusterRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public RestoreClusterRequest.Builder clearParent()

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

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

Returns
Type Description
RestoreClusterRequest.Builder

This builder for chaining.

clearRequestId()

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

Returns
Type Description
RestoreClusterRequest.Builder

This builder for chaining.

clearSource()

public RestoreClusterRequest.Builder clearSource()
Returns
Type Description
RestoreClusterRequest.Builder

clearValidateOnly()

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

Returns
Type Description
RestoreClusterRequest.Builder

This builder for chaining.

clone()

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

getBackupSource()

public BackupSource getBackupSource()

Backup source.

.google.cloud.alloydb.v1.BackupSource backup_source = 4;

Returns
Type Description
BackupSource

The backupSource.

getBackupSourceBuilder()

public BackupSource.Builder getBackupSourceBuilder()

Backup source.

.google.cloud.alloydb.v1.BackupSource backup_source = 4;

Returns
Type Description
BackupSource.Builder

getBackupSourceOrBuilder()

public BackupSourceOrBuilder getBackupSourceOrBuilder()

Backup source.

.google.cloud.alloydb.v1.BackupSource backup_source = 4;

Returns
Type Description
BackupSourceOrBuilder

getCluster()

public Cluster getCluster()

Required. The resource being created

.google.cloud.alloydb.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Cluster

The cluster.

getClusterBuilder()

public Cluster.Builder getClusterBuilder()

Required. The resource being created

.google.cloud.alloydb.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Cluster.Builder

getClusterId()

public String getClusterId()

Required. ID of the requesting object.

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

Returns
Type Description
String

The clusterId.

getClusterIdBytes()

public ByteString getClusterIdBytes()

Required. ID of the requesting object.

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

Returns
Type Description
ByteString

The bytes for clusterId.

getClusterOrBuilder()

public ClusterOrBuilder getClusterOrBuilder()

Required. The resource being created

.google.cloud.alloydb.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ClusterOrBuilder

getContinuousBackupSource()

public ContinuousBackupSource getContinuousBackupSource()

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.

.google.cloud.alloydb.v1.ContinuousBackupSource continuous_backup_source = 8;

Returns
Type Description
ContinuousBackupSource

The continuousBackupSource.

getContinuousBackupSourceBuilder()

public ContinuousBackupSource.Builder getContinuousBackupSourceBuilder()

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.

.google.cloud.alloydb.v1.ContinuousBackupSource continuous_backup_source = 8;

Returns
Type Description
ContinuousBackupSource.Builder

getContinuousBackupSourceOrBuilder()

public ContinuousBackupSourceOrBuilder getContinuousBackupSourceOrBuilder()

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.

.google.cloud.alloydb.v1.ContinuousBackupSource continuous_backup_source = 8;

Returns
Type Description
ContinuousBackupSourceOrBuilder

getDefaultInstanceForType()

public RestoreClusterRequest getDefaultInstanceForType()
Returns
Type Description
RestoreClusterRequest

getDescriptorForType()

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

getParent()

public String getParent()

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

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

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

Returns
Type Description
ByteString

The bytes for parent.

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

Returns
Type Description
ByteString

The bytes for requestId.

getSourceCase()

public RestoreClusterRequest.SourceCase getSourceCase()
Returns
Type Description
RestoreClusterRequest.SourceCase

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

Returns
Type Description
boolean

The validateOnly.

hasBackupSource()

public boolean hasBackupSource()

Backup source.

.google.cloud.alloydb.v1.BackupSource backup_source = 4;

Returns
Type Description
boolean

Whether the backupSource field is set.

hasCluster()

public boolean hasCluster()

Required. The resource being created

.google.cloud.alloydb.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the cluster field is set.

hasContinuousBackupSource()

public boolean hasContinuousBackupSource()

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.

.google.cloud.alloydb.v1.ContinuousBackupSource continuous_backup_source = 8;

Returns
Type Description
boolean

Whether the continuousBackupSource field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBackupSource(BackupSource value)

public RestoreClusterRequest.Builder mergeBackupSource(BackupSource value)

Backup source.

.google.cloud.alloydb.v1.BackupSource backup_source = 4;

Parameter
Name Description
value BackupSource
Returns
Type Description
RestoreClusterRequest.Builder

mergeCluster(Cluster value)

public RestoreClusterRequest.Builder mergeCluster(Cluster value)

Required. The resource being created

.google.cloud.alloydb.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Cluster
Returns
Type Description
RestoreClusterRequest.Builder

mergeContinuousBackupSource(ContinuousBackupSource value)

public RestoreClusterRequest.Builder mergeContinuousBackupSource(ContinuousBackupSource value)

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.

.google.cloud.alloydb.v1.ContinuousBackupSource continuous_backup_source = 8;

Parameter
Name Description
value ContinuousBackupSource
Returns
Type Description
RestoreClusterRequest.Builder

mergeFrom(RestoreClusterRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBackupSource(BackupSource value)

public RestoreClusterRequest.Builder setBackupSource(BackupSource value)

Backup source.

.google.cloud.alloydb.v1.BackupSource backup_source = 4;

Parameter
Name Description
value BackupSource
Returns
Type Description
RestoreClusterRequest.Builder

setBackupSource(BackupSource.Builder builderForValue)

public RestoreClusterRequest.Builder setBackupSource(BackupSource.Builder builderForValue)

Backup source.

.google.cloud.alloydb.v1.BackupSource backup_source = 4;

Parameter
Name Description
builderForValue BackupSource.Builder
Returns
Type Description
RestoreClusterRequest.Builder

setCluster(Cluster value)

public RestoreClusterRequest.Builder setCluster(Cluster value)

Required. The resource being created

.google.cloud.alloydb.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Cluster
Returns
Type Description
RestoreClusterRequest.Builder

setCluster(Cluster.Builder builderForValue)

public RestoreClusterRequest.Builder setCluster(Cluster.Builder builderForValue)

Required. The resource being created

.google.cloud.alloydb.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Cluster.Builder
Returns
Type Description
RestoreClusterRequest.Builder

setClusterId(String value)

public RestoreClusterRequest.Builder setClusterId(String value)

Required. ID of the requesting object.

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

Parameter
Name Description
value String

The clusterId to set.

Returns
Type Description
RestoreClusterRequest.Builder

This builder for chaining.

setClusterIdBytes(ByteString value)

public RestoreClusterRequest.Builder setClusterIdBytes(ByteString value)

Required. ID of the requesting object.

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

Parameter
Name Description
value ByteString

The bytes for clusterId to set.

Returns
Type Description
RestoreClusterRequest.Builder

This builder for chaining.

setContinuousBackupSource(ContinuousBackupSource value)

public RestoreClusterRequest.Builder setContinuousBackupSource(ContinuousBackupSource value)

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.

.google.cloud.alloydb.v1.ContinuousBackupSource continuous_backup_source = 8;

Parameter
Name Description
value ContinuousBackupSource
Returns
Type Description
RestoreClusterRequest.Builder

setContinuousBackupSource(ContinuousBackupSource.Builder builderForValue)

public RestoreClusterRequest.Builder setContinuousBackupSource(ContinuousBackupSource.Builder builderForValue)

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.

.google.cloud.alloydb.v1.ContinuousBackupSource continuous_backup_source = 8;

Parameter
Name Description
builderForValue ContinuousBackupSource.Builder
Returns
Type Description
RestoreClusterRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setParent(String value)

public RestoreClusterRequest.Builder setParent(String value)

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

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
RestoreClusterRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public RestoreClusterRequest.Builder setParentBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
RestoreClusterRequest.Builder

This builder for chaining.

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

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

setRequestId(String value)

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

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
RestoreClusterRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
RestoreClusterRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setValidateOnly(boolean value)

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

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
RestoreClusterRequest.Builder

This builder for chaining.