Class RestoreDatabaseRequest (6.69.0)

public final class RestoreDatabaseRequest extends GeneratedMessageV3 implements RestoreDatabaseRequestOrBuilder

The request for RestoreDatabase.

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

Static Fields

BACKUP_FIELD_NUMBER

public static final int BACKUP_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_CONFIG_FIELD_NUMBER

public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RestoreDatabaseRequest getDefaultInstance()
Returns
Type Description
RestoreDatabaseRequest

getDescriptor()

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

newBuilder()

public static RestoreDatabaseRequest.Builder newBuilder()
Returns
Type Description
RestoreDatabaseRequest.Builder

newBuilder(RestoreDatabaseRequest prototype)

public static RestoreDatabaseRequest.Builder newBuilder(RestoreDatabaseRequest prototype)
Parameter
Name Description
prototype RestoreDatabaseRequest
Returns
Type Description
RestoreDatabaseRequest.Builder

parseDelimitedFrom(InputStream input)

public static RestoreDatabaseRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RestoreDatabaseRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RestoreDatabaseRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RestoreDatabaseRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RestoreDatabaseRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RestoreDatabaseRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RestoreDatabaseRequest> parser()
Returns
Type Description
Parser<RestoreDatabaseRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

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.

getParserForType()

public Parser<RestoreDatabaseRequest> getParserForType()
Returns
Type Description
Parser<RestoreDatabaseRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RestoreDatabaseRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RestoreDatabaseRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException