Class RestoreDatabaseRequest (6.89.0)

publicfinalclassRestoreDatabaseRequestextendsGeneratedMessageV3implementsRestoreDatabaseRequestOrBuilder

The request for RestoreDatabase.

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

Static Fields

BACKUP_FIELD_NUMBER

publicstaticfinalintBACKUP_FIELD_NUMBER
Field Value
TypeDescription
int

DATABASE_ID_FIELD_NUMBER

publicstaticfinalintDATABASE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPTION_CONFIG_FIELD_NUMBER

publicstaticfinalintENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

publicstaticfinalintPARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticRestoreDatabaseRequestgetDefaultInstance()
Returns
TypeDescription
RestoreDatabaseRequest

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticRestoreDatabaseRequest.BuildernewBuilder()
Returns
TypeDescription
RestoreDatabaseRequest.Builder

newBuilder(RestoreDatabaseRequest prototype)

publicstaticRestoreDatabaseRequest.BuildernewBuilder(RestoreDatabaseRequestprototype)
Parameter
NameDescription
prototypeRestoreDatabaseRequest
Returns
TypeDescription
RestoreDatabaseRequest.Builder

parseDelimitedFrom(InputStream input)

publicstaticRestoreDatabaseRequestparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreDatabaseRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticRestoreDatabaseRequestparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreDatabaseRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticRestoreDatabaseRequestparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreDatabaseRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticRestoreDatabaseRequestparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreDatabaseRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticRestoreDatabaseRequestparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreDatabaseRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticRestoreDatabaseRequestparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreDatabaseRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<RestoreDatabaseRequest>parser()
Returns
TypeDescription
Parser<RestoreDatabaseRequest>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBackup()

publicStringgetBackup()

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

publicByteStringgetBackupBytes()

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

publicStringgetDatabaseId()

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

publicByteStringgetDatabaseIdBytes()

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.

getDefaultInstanceForType()

publicRestoreDatabaseRequestgetDefaultInstanceForType()
Returns
TypeDescription
RestoreDatabaseRequest

getEncryptionConfig()

publicRestoreDatabaseEncryptionConfiggetEncryptionConfig()

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

publicRestoreDatabaseEncryptionConfigOrBuildergetEncryptionConfigOrBuilder()

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

publicStringgetParent()

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

publicByteStringgetParentBytes()

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

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

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

publicRestoreDatabaseRequest.SourceCasegetSourceCase()
Returns
TypeDescription
RestoreDatabaseRequest.SourceCase

hasBackup()

publicbooleanhasBackup()

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

publicbooleanhasEncryptionConfig()

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

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicRestoreDatabaseRequest.BuildernewBuilderForType()
Returns
TypeDescription
RestoreDatabaseRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedRestoreDatabaseRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RestoreDatabaseRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicRestoreDatabaseRequest.BuildertoBuilder()
Returns
TypeDescription
RestoreDatabaseRequest.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException