public interface RestoreDatabaseRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsTags(String key)
public abstract boolean containsTags(String key)Optional. Immutable. Tags to be bound to the restored database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getBackup()
public abstract 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 abstract 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 abstract 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 abstract 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. |
getEncryptionConfig()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
Database.EncryptionConfig |
The encryptionConfig. |
getEncryptionConfigOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
Database.EncryptionConfigOrBuilder |
|
getParent()
public abstract 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 abstract 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. |
getTags() (deprecated)
public abstract Map<String,String> getTags()Use #getTagsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getTagsCount()
public abstract int getTagsCount()Optional. Immutable. Tags to be bound to the restored database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getTagsMap()
public abstract Map<String,String> getTagsMap()Optional. Immutable. Tags to be bound to the restored database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getTagsOrDefault(String key, String defaultValue)
public abstract String getTagsOrDefault(String key, String defaultValue)Optional. Immutable. Tags to be bound to the restored database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getTagsOrThrow(String key)
public abstract String getTagsOrThrow(String key)Optional. Immutable. Tags to be bound to the restored database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
hasEncryptionConfig()
public abstract 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. |