Class RestoreDatabaseRequest.Builder (6.82.0)

public static final class RestoreDatabaseRequest.Builder extends GeneratedMessageV3.Builder<RestoreDatabaseRequest.Builder> implements RestoreDatabaseRequestOrBuilder

The request for RestoreDatabase.

Protobuf type google.spanner.admin.database.v1.RestoreDatabaseRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RestoreDatabaseRequest build()
Returns
Type Description
RestoreDatabaseRequest

buildPartial()

public RestoreDatabaseRequest buildPartial()
Returns
Type Description
RestoreDatabaseRequest

clear()

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

clearBackup()

public RestoreDatabaseRequest.Builder clearBackup()

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

string backup = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
RestoreDatabaseRequest.Builder

This builder for chaining.

clearDatabaseId()

public RestoreDatabaseRequest.Builder clearDatabaseId()

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

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

Returns
Type Description
RestoreDatabaseRequest.Builder

This builder for chaining.

clearEncryptionConfig()

public RestoreDatabaseRequest.Builder clearEncryptionConfig()

Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreDatabaseRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public RestoreDatabaseRequest.Builder clearParent()

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

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

Returns
Type Description
RestoreDatabaseRequest.Builder

This builder for chaining.

clearSource()

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

clone()

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

getBackup()

public String getBackup()

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

string backup = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The backup.

getBackupBytes()

public ByteString getBackupBytes()

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

string backup = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for backup.

getDatabaseId()

public String getDatabaseId()

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

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

Returns
Type Description
String

The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

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

Returns
Type Description
ByteString

The bytes for databaseId.

getDefaultInstanceForType()

public RestoreDatabaseRequest getDefaultInstanceForType()
Returns
Type Description
RestoreDatabaseRequest

getDescriptorForType()

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

getEncryptionConfig()

public RestoreDatabaseEncryptionConfig getEncryptionConfig()

Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreDatabaseEncryptionConfig

The encryptionConfig.

getEncryptionConfigBuilder()

public RestoreDatabaseEncryptionConfig.Builder getEncryptionConfigBuilder()

Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreDatabaseEncryptionConfig.Builder

getEncryptionConfigOrBuilder()

public RestoreDatabaseEncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreDatabaseEncryptionConfigOrBuilder

getParent()

public String getParent()

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

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 instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

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

Returns
Type Description
ByteString

The bytes for parent.

getSourceCase()

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

hasBackup()

public boolean hasBackup()

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

string backup = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the backup field is set.

hasEncryptionConfig()

public boolean hasEncryptionConfig()

Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the encryptionConfig field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEncryptionConfig(RestoreDatabaseEncryptionConfig value)

public RestoreDatabaseRequest.Builder mergeEncryptionConfig(RestoreDatabaseEncryptionConfig value)

Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value RestoreDatabaseEncryptionConfig
Returns
Type Description
RestoreDatabaseRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(RestoreDatabaseRequest other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBackup(String value)

public RestoreDatabaseRequest.Builder setBackup(String value)

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

string backup = 3 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The backup to set.

Returns
Type Description
RestoreDatabaseRequest.Builder

This builder for chaining.

setBackupBytes(ByteString value)

public RestoreDatabaseRequest.Builder setBackupBytes(ByteString value)

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

string backup = 3 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for backup to set.

Returns
Type Description
RestoreDatabaseRequest.Builder

This builder for chaining.

setDatabaseId(String value)

public RestoreDatabaseRequest.Builder setDatabaseId(String value)

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

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

Parameter
Name Description
value String

The databaseId to set.

Returns
Type Description
RestoreDatabaseRequest.Builder

This builder for chaining.

setDatabaseIdBytes(ByteString value)

public RestoreDatabaseRequest.Builder setDatabaseIdBytes(ByteString value)

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

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

Parameter
Name Description
value ByteString

The bytes for databaseId to set.

Returns
Type Description
RestoreDatabaseRequest.Builder

This builder for chaining.

setEncryptionConfig(RestoreDatabaseEncryptionConfig value)

public RestoreDatabaseRequest.Builder setEncryptionConfig(RestoreDatabaseEncryptionConfig value)

Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value RestoreDatabaseEncryptionConfig
Returns
Type Description
RestoreDatabaseRequest.Builder

setEncryptionConfig(RestoreDatabaseEncryptionConfig.Builder builderForValue)

public RestoreDatabaseRequest.Builder setEncryptionConfig(RestoreDatabaseEncryptionConfig.Builder builderForValue)

Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue RestoreDatabaseEncryptionConfig.Builder
Returns
Type Description
RestoreDatabaseRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setParent(String value)

public RestoreDatabaseRequest.Builder setParent(String value)

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
RestoreDatabaseRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public RestoreDatabaseRequest.Builder setParentBytes(ByteString value)

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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