public final class RestoreDatabaseRequest extends GeneratedMessageV3 implements RestoreDatabaseRequestOrBuilder
The request message for
FirestoreAdmin.RestoreDatabase.
Protobuf type google.firestore.admin.v1.RestoreDatabaseRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RestoreDatabaseRequest.Builder newBuilder()
newBuilder(RestoreDatabaseRequest prototype)
public static RestoreDatabaseRequest.Builder newBuilder(RestoreDatabaseRequest prototype)
public static RestoreDatabaseRequest parseDelimitedFrom(InputStream input)
public static RestoreDatabaseRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RestoreDatabaseRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RestoreDatabaseRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RestoreDatabaseRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestoreDatabaseRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestoreDatabaseRequest parseFrom(CodedInputStream input)
public static RestoreDatabaseRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RestoreDatabaseRequest parseFrom(InputStream input)
public static RestoreDatabaseRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RestoreDatabaseRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RestoreDatabaseRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RestoreDatabaseRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBackup()
public String getBackup()
Required. Backup to restore from. Must be from the same project as the
parent.
The restored database will be created in the same location as the source
backup.
Format is: projects/{project_id}/locations/{location}/backups/{backup}
string backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The backup.
|
getBackupBytes()
public ByteString getBackupBytes()
Required. Backup to restore from. Must be from the same project as the
parent.
The restored database will be created in the same location as the source
backup.
Format is: projects/{project_id}/locations/{location}/backups/{backup}
string backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for backup.
|
getDatabaseId()
public String getDatabaseId()
Required. The ID to use for the database, which will become the final
component of the database's resource name. This database ID must not be
associated with an existing database.
This value should be 4-63 characters. Valid characters are /a-z-/
with first character a letter and the last a letter or a number. Must not
be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.
"(default)" database ID is also valid.
string database_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The databaseId.
|
getDatabaseIdBytes()
public ByteString getDatabaseIdBytes()
Required. The ID to use for the database, which will become the final
component of the database's resource name. This database ID must not be
associated with an existing database.
This value should be 4-63 characters. Valid characters are /a-z-/
with first character a letter and the last a letter or a number. Must not
be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.
"(default)" database ID is also valid.
string database_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for databaseId.
|
getDefaultInstanceForType()
public RestoreDatabaseRequest getDefaultInstanceForType()
getEncryptionConfig()
public Database.EncryptionConfig getEncryptionConfig()
Optional. Encryption configuration for the restored database.
If this field is not specified, the restored database will use
the same encryption configuration as the backup, namely
use_source_encryption.
.google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 9 [(.google.api.field_behavior) = OPTIONAL];
getEncryptionConfigOrBuilder()
public Database.EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
Optional. Encryption configuration for the restored database.
If this field is not specified, the restored database will use
the same encryption configuration as the backup, namely
use_source_encryption.
.google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 9 [(.google.api.field_behavior) = OPTIONAL];
getParent()
public String getParent()
Required. The project to restore the database in. Format is
projects/{project_id}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The project to restore the database in. Format is
projects/{project_id}.
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()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasEncryptionConfig()
public boolean hasEncryptionConfig()
Optional. Encryption configuration for the restored database.
If this field is not specified, the restored database will use
the same encryption configuration as the backup, namely
use_source_encryption.
.google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the encryptionConfig field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RestoreDatabaseRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RestoreDatabaseRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public RestoreDatabaseRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
