Class RestoreCloudDatabaseAction.Builder (6.68.0)

public static final class RestoreCloudDatabaseAction.Builder extends GeneratedMessageV3.Builder<RestoreCloudDatabaseAction.Builder> implements RestoreCloudDatabaseActionOrBuilder

Action that restores a Cloud Spanner database from a backup.

Protobuf type google.spanner.executor.v1.RestoreCloudDatabaseAction

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RestoreCloudDatabaseAction build()
Returns
Type Description
RestoreCloudDatabaseAction

buildPartial()

public RestoreCloudDatabaseAction buildPartial()
Returns
Type Description
RestoreCloudDatabaseAction

clear()

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

clearBackupId()

public RestoreCloudDatabaseAction.Builder clearBackupId()

The id of the backup from which to restore, e.g. "test-backup".

string backup_id = 3;

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

clearBackupInstanceId()

public RestoreCloudDatabaseAction.Builder clearBackupInstanceId()

Cloud instance ID (not path) containing the backup, e.g. "backup-instance".

string backup_instance_id = 2;

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

clearDatabaseId()

public RestoreCloudDatabaseAction.Builder clearDatabaseId()

The id of the database to create and restore to, e.g. "db0". Note that this database must not already exist.

string database_id = 5;

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

clearDatabaseInstanceId()

public RestoreCloudDatabaseAction.Builder clearDatabaseInstanceId()

Cloud instance ID (not path) containing the database, e.g. "database-instance".

string database_instance_id = 4;

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

clearEncryptionConfig()

public RestoreCloudDatabaseAction.Builder clearEncryptionConfig()

The KMS key(s) used to encrypt the restored database to be created if the restored database should be CMEK protected.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 7;

Returns
Type Description
RestoreCloudDatabaseAction.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProjectId()

public RestoreCloudDatabaseAction.Builder clearProjectId()

Cloud project ID, e.g. "spanner-cloud-systest".

string project_id = 1;

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

clone()

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

getBackupId()

public String getBackupId()

The id of the backup from which to restore, e.g. "test-backup".

string backup_id = 3;

Returns
Type Description
String

The backupId.

getBackupIdBytes()

public ByteString getBackupIdBytes()

The id of the backup from which to restore, e.g. "test-backup".

string backup_id = 3;

Returns
Type Description
ByteString

The bytes for backupId.

getBackupInstanceId()

public String getBackupInstanceId()

Cloud instance ID (not path) containing the backup, e.g. "backup-instance".

string backup_instance_id = 2;

Returns
Type Description
String

The backupInstanceId.

getBackupInstanceIdBytes()

public ByteString getBackupInstanceIdBytes()

Cloud instance ID (not path) containing the backup, e.g. "backup-instance".

string backup_instance_id = 2;

Returns
Type Description
ByteString

The bytes for backupInstanceId.

getDatabaseId()

public String getDatabaseId()

The id of the database to create and restore to, e.g. "db0". Note that this database must not already exist.

string database_id = 5;

Returns
Type Description
String

The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

The id of the database to create and restore to, e.g. "db0". Note that this database must not already exist.

string database_id = 5;

Returns
Type Description
ByteString

The bytes for databaseId.

getDatabaseInstanceId()

public String getDatabaseInstanceId()

Cloud instance ID (not path) containing the database, e.g. "database-instance".

string database_instance_id = 4;

Returns
Type Description
String

The databaseInstanceId.

getDatabaseInstanceIdBytes()

public ByteString getDatabaseInstanceIdBytes()

Cloud instance ID (not path) containing the database, e.g. "database-instance".

string database_instance_id = 4;

Returns
Type Description
ByteString

The bytes for databaseInstanceId.

getDefaultInstanceForType()

public RestoreCloudDatabaseAction getDefaultInstanceForType()
Returns
Type Description
RestoreCloudDatabaseAction

getDescriptorForType()

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

getEncryptionConfig()

public EncryptionConfig getEncryptionConfig()

The KMS key(s) used to encrypt the restored database to be created if the restored database should be CMEK protected.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 7;

Returns
Type Description
EncryptionConfig

The encryptionConfig.

getEncryptionConfigBuilder()

public EncryptionConfig.Builder getEncryptionConfigBuilder()

The KMS key(s) used to encrypt the restored database to be created if the restored database should be CMEK protected.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 7;

Returns
Type Description
EncryptionConfig.Builder

getEncryptionConfigOrBuilder()

public EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

The KMS key(s) used to encrypt the restored database to be created if the restored database should be CMEK protected.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 7;

Returns
Type Description
EncryptionConfigOrBuilder

getProjectId()

public String getProjectId()

Cloud project ID, e.g. "spanner-cloud-systest".

string project_id = 1;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Cloud project ID, e.g. "spanner-cloud-systest".

string project_id = 1;

Returns
Type Description
ByteString

The bytes for projectId.

hasEncryptionConfig()

public boolean hasEncryptionConfig()

The KMS key(s) used to encrypt the restored database to be created if the restored database should be CMEK protected.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 7;

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(EncryptionConfig value)

public RestoreCloudDatabaseAction.Builder mergeEncryptionConfig(EncryptionConfig value)

The KMS key(s) used to encrypt the restored database to be created if the restored database should be CMEK protected.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 7;

Parameter
Name Description
value EncryptionConfig
Returns
Type Description
RestoreCloudDatabaseAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(RestoreCloudDatabaseAction other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBackupId(String value)

public RestoreCloudDatabaseAction.Builder setBackupId(String value)

The id of the backup from which to restore, e.g. "test-backup".

string backup_id = 3;

Parameter
Name Description
value String

The backupId to set.

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

setBackupIdBytes(ByteString value)

public RestoreCloudDatabaseAction.Builder setBackupIdBytes(ByteString value)

The id of the backup from which to restore, e.g. "test-backup".

string backup_id = 3;

Parameter
Name Description
value ByteString

The bytes for backupId to set.

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

setBackupInstanceId(String value)

public RestoreCloudDatabaseAction.Builder setBackupInstanceId(String value)

Cloud instance ID (not path) containing the backup, e.g. "backup-instance".

string backup_instance_id = 2;

Parameter
Name Description
value String

The backupInstanceId to set.

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

setBackupInstanceIdBytes(ByteString value)

public RestoreCloudDatabaseAction.Builder setBackupInstanceIdBytes(ByteString value)

Cloud instance ID (not path) containing the backup, e.g. "backup-instance".

string backup_instance_id = 2;

Parameter
Name Description
value ByteString

The bytes for backupInstanceId to set.

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

setDatabaseId(String value)

public RestoreCloudDatabaseAction.Builder setDatabaseId(String value)

The id of the database to create and restore to, e.g. "db0". Note that this database must not already exist.

string database_id = 5;

Parameter
Name Description
value String

The databaseId to set.

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

setDatabaseIdBytes(ByteString value)

public RestoreCloudDatabaseAction.Builder setDatabaseIdBytes(ByteString value)

The id of the database to create and restore to, e.g. "db0". Note that this database must not already exist.

string database_id = 5;

Parameter
Name Description
value ByteString

The bytes for databaseId to set.

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

setDatabaseInstanceId(String value)

public RestoreCloudDatabaseAction.Builder setDatabaseInstanceId(String value)

Cloud instance ID (not path) containing the database, e.g. "database-instance".

string database_instance_id = 4;

Parameter
Name Description
value String

The databaseInstanceId to set.

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

setDatabaseInstanceIdBytes(ByteString value)

public RestoreCloudDatabaseAction.Builder setDatabaseInstanceIdBytes(ByteString value)

Cloud instance ID (not path) containing the database, e.g. "database-instance".

string database_instance_id = 4;

Parameter
Name Description
value ByteString

The bytes for databaseInstanceId to set.

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

setEncryptionConfig(EncryptionConfig value)

public RestoreCloudDatabaseAction.Builder setEncryptionConfig(EncryptionConfig value)

The KMS key(s) used to encrypt the restored database to be created if the restored database should be CMEK protected.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 7;

Parameter
Name Description
value EncryptionConfig
Returns
Type Description
RestoreCloudDatabaseAction.Builder

setEncryptionConfig(EncryptionConfig.Builder builderForValue)

public RestoreCloudDatabaseAction.Builder setEncryptionConfig(EncryptionConfig.Builder builderForValue)

The KMS key(s) used to encrypt the restored database to be created if the restored database should be CMEK protected.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 7;

Parameter
Name Description
builderForValue EncryptionConfig.Builder
Returns
Type Description
RestoreCloudDatabaseAction.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setProjectId(String value)

public RestoreCloudDatabaseAction.Builder setProjectId(String value)

Cloud project ID, e.g. "spanner-cloud-systest".

string project_id = 1;

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public RestoreCloudDatabaseAction.Builder setProjectIdBytes(ByteString value)

Cloud project ID, e.g. "spanner-cloud-systest".

string project_id = 1;

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
RestoreCloudDatabaseAction.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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