Class RestoreDatabaseRequest

public final class RestoreDatabaseRequest extends GeneratedMessageV3 implements RestoreDatabaseRequestOrBuilder

The request for RestoreDatabase.

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

Fields

BACKUP_FIELD_NUMBER

public static final int BACKUP_FIELD_NUMBER
Field Value
TypeDescription
int

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPTION_CONFIG_FIELD_NUMBER

public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for databaseId.

getDefaultInstance()

public static RestoreDatabaseRequest getDefaultInstance()
Returns
TypeDescription
RestoreDatabaseRequest

getDefaultInstanceForType()

public RestoreDatabaseRequest getDefaultInstanceForType()
Returns
TypeDescription
RestoreDatabaseRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<RestoreDatabaseRequest> getParserForType()
Returns
TypeDescription
Parser<RestoreDatabaseRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public RestoreDatabaseRequest.SourceCase getSourceCase()
Returns
TypeDescription
RestoreDatabaseRequest.SourceCase

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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
TypeDescription
boolean

Whether the encryptionConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static RestoreDatabaseRequest.Builder newBuilder()
Returns
TypeDescription
RestoreDatabaseRequest.Builder

newBuilder(RestoreDatabaseRequest prototype)

public static RestoreDatabaseRequest.Builder newBuilder(RestoreDatabaseRequest prototype)
Parameter
NameDescription
prototypeRestoreDatabaseRequest
Returns
TypeDescription
RestoreDatabaseRequest.Builder

newBuilderForType()

public RestoreDatabaseRequest.Builder newBuilderForType()
Returns
TypeDescription
RestoreDatabaseRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RestoreDatabaseRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RestoreDatabaseRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static RestoreDatabaseRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RestoreDatabaseRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RestoreDatabaseRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RestoreDatabaseRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RestoreDatabaseRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RestoreDatabaseRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RestoreDatabaseRequest> parser()
Returns
TypeDescription
Parser<RestoreDatabaseRequest>

toBuilder()

public RestoreDatabaseRequest.Builder toBuilder()
Returns
TypeDescription
RestoreDatabaseRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException