public static final class RestoreDatabaseRequest.Builder extends GeneratedMessageV3.Builder<RestoreDatabaseRequest.Builder> implements RestoreDatabaseRequestOrBuilderThe request message for FirestoreAdmin.RestoreDatabase.
Protobuf type google.firestore.admin.v1.RestoreDatabaseRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RestoreDatabaseRequest.BuilderImplements
RestoreDatabaseRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RestoreDatabaseRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
build()
public RestoreDatabaseRequest build()| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest |
|
buildPartial()
public RestoreDatabaseRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest |
|
clear()
public RestoreDatabaseRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
clearBackup()
public RestoreDatabaseRequest.Builder clearBackup()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 |
RestoreDatabaseRequest.Builder |
This builder for chaining. |
clearDatabaseId()
public RestoreDatabaseRequest.Builder clearDatabaseId()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 |
RestoreDatabaseRequest.Builder |
This builder for chaining. |
clearEncryptionConfig()
public RestoreDatabaseRequest.Builder clearEncryptionConfig()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 |
RestoreDatabaseRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public RestoreDatabaseRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public RestoreDatabaseRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
clearParent()
public RestoreDatabaseRequest.Builder clearParent() 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 |
RestoreDatabaseRequest.Builder |
This builder for chaining. |
clone()
public RestoreDatabaseRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
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()| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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];
| Returns | |
|---|---|
| Type | Description |
Database.EncryptionConfig |
The encryptionConfig. |
getEncryptionConfigBuilder()
public Database.EncryptionConfig.Builder getEncryptionConfigBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
Database.EncryptionConfigOrBuilder |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeEncryptionConfig(Database.EncryptionConfig value)
public RestoreDatabaseRequest.Builder mergeEncryptionConfig(Database.EncryptionConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Database.EncryptionConfig |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
mergeFrom(RestoreDatabaseRequest other)
public RestoreDatabaseRequest.Builder mergeFrom(RestoreDatabaseRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
RestoreDatabaseRequest |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RestoreDatabaseRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public RestoreDatabaseRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RestoreDatabaseRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
setBackup(String value)
public RestoreDatabaseRequest.Builder setBackup(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe backup to set. |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
This builder for chaining. |
setBackupBytes(ByteString value)
public RestoreDatabaseRequest.Builder setBackupBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for backup to set. |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
This builder for chaining. |
setDatabaseId(String value)
public RestoreDatabaseRequest.Builder setDatabaseId(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe databaseId to set. |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
This builder for chaining. |
setDatabaseIdBytes(ByteString value)
public RestoreDatabaseRequest.Builder setDatabaseIdBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for databaseId to set. |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
This builder for chaining. |
setEncryptionConfig(Database.EncryptionConfig value)
public RestoreDatabaseRequest.Builder setEncryptionConfig(Database.EncryptionConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Database.EncryptionConfig |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
setEncryptionConfig(Database.EncryptionConfig.Builder builderForValue)
public RestoreDatabaseRequest.Builder setEncryptionConfig(Database.EncryptionConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Database.EncryptionConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public RestoreDatabaseRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
setParent(String value)
public RestoreDatabaseRequest.Builder setParent(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public RestoreDatabaseRequest.Builder setParentBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RestoreDatabaseRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final RestoreDatabaseRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseRequest.Builder |
|