public static final class CloneDatabaseRequest.Builder extends GeneratedMessageV3.Builder<CloneDatabaseRequest.Builder> implements CloneDatabaseRequestOrBuilderThe request message for FirestoreAdmin.CloneDatabase.
Protobuf type google.firestore.admin.v1.CloneDatabaseRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CloneDatabaseRequest.BuilderImplements
CloneDatabaseRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CloneDatabaseRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
build()
public CloneDatabaseRequest build()| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest |
|
buildPartial()
public CloneDatabaseRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest |
|
clear()
public CloneDatabaseRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
clearDatabaseId()
public CloneDatabaseRequest.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 |
CloneDatabaseRequest.Builder |
This builder for chaining. |
clearEncryptionConfig()
public CloneDatabaseRequest.Builder clearEncryptionConfig()Optional. Encryption configuration for the cloned database.
If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
.google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public CloneDatabaseRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public CloneDatabaseRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
clearParent()
public CloneDatabaseRequest.Builder clearParent() Required. The project to clone the database in. Format is
projects/{project_id}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
This builder for chaining. |
clearPitrSnapshot()
public CloneDatabaseRequest.Builder clearPitrSnapshot()Required. Specification of the PITR data to clone from. The source database must exist.
The cloned database will be created in the same location as the source database.
.google.firestore.admin.v1.PitrSnapshot pitr_snapshot = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
clearTags()
public CloneDatabaseRequest.Builder clearTags()| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
clone()
public CloneDatabaseRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
containsTags(String key)
public boolean containsTags(String key)Optional. Immutable. Tags to be bound to the cloned database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 CloneDatabaseRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEncryptionConfig()
public Database.EncryptionConfig getEncryptionConfig()Optional. Encryption configuration for the cloned database.
If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
.google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Database.EncryptionConfig |
The encryptionConfig. |
getEncryptionConfigBuilder()
public Database.EncryptionConfig.Builder getEncryptionConfigBuilder()Optional. Encryption configuration for the cloned database.
If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
.google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Database.EncryptionConfig.Builder |
|
getEncryptionConfigOrBuilder()
public Database.EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()Optional. Encryption configuration for the cloned database.
If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
.google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Database.EncryptionConfigOrBuilder |
|
getMutableTags() (deprecated)
public Map<String,String> getMutableTags()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getParent()
public String getParent() Required. The project to clone 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 clone 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. |
getPitrSnapshot()
public PitrSnapshot getPitrSnapshot()Required. Specification of the PITR data to clone from. The source database must exist.
The cloned database will be created in the same location as the source database.
.google.firestore.admin.v1.PitrSnapshot pitr_snapshot = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot |
The pitrSnapshot. |
getPitrSnapshotBuilder()
public PitrSnapshot.Builder getPitrSnapshotBuilder()Required. Specification of the PITR data to clone from. The source database must exist.
The cloned database will be created in the same location as the source database.
.google.firestore.admin.v1.PitrSnapshot pitr_snapshot = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
|
getPitrSnapshotOrBuilder()
public PitrSnapshotOrBuilder getPitrSnapshotOrBuilder()Required. Specification of the PITR data to clone from. The source database must exist.
The cloned database will be created in the same location as the source database.
.google.firestore.admin.v1.PitrSnapshot pitr_snapshot = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PitrSnapshotOrBuilder |
|
getTags() (deprecated)
public Map<String,String> getTags()Use #getTagsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getTagsCount()
public int getTagsCount()Optional. Immutable. Tags to be bound to the cloned database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getTagsMap()
public Map<String,String> getTagsMap()Optional. Immutable. Tags to be bound to the cloned database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getTagsOrDefault(String key, String defaultValue)
public String getTagsOrDefault(String key, String defaultValue)Optional. Immutable. Tags to be bound to the cloned database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 5 [(.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 String getTagsOrThrow(String key)Optional. Immutable. Tags to be bound to the cloned database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
hasEncryptionConfig()
public boolean hasEncryptionConfig()Optional. Encryption configuration for the cloned database.
If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
.google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the encryptionConfig field is set. |
hasPitrSnapshot()
public boolean hasPitrSnapshot()Required. Specification of the PITR data to clone from. The source database must exist.
The cloned database will be created in the same location as the source database.
.google.firestore.admin.v1.PitrSnapshot pitr_snapshot = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pitrSnapshot field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeEncryptionConfig(Database.EncryptionConfig value)
public CloneDatabaseRequest.Builder mergeEncryptionConfig(Database.EncryptionConfig value)Optional. Encryption configuration for the cloned database.
If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
.google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Database.EncryptionConfig |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
mergeFrom(CloneDatabaseRequest other)
public CloneDatabaseRequest.Builder mergeFrom(CloneDatabaseRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
CloneDatabaseRequest |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CloneDatabaseRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CloneDatabaseRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
mergePitrSnapshot(PitrSnapshot value)
public CloneDatabaseRequest.Builder mergePitrSnapshot(PitrSnapshot value)Required. Specification of the PITR data to clone from. The source database must exist.
The cloned database will be created in the same location as the source database.
.google.firestore.admin.v1.PitrSnapshot pitr_snapshot = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
PitrSnapshot |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CloneDatabaseRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
putAllTags(Map<String,String> values)
public CloneDatabaseRequest.Builder putAllTags(Map<String,String> values)Optional. Immutable. Tags to be bound to the cloned database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
putTags(String key, String value)
public CloneDatabaseRequest.Builder putTags(String key, String value)Optional. Immutable. Tags to be bound to the cloned database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
removeTags(String key)
public CloneDatabaseRequest.Builder removeTags(String key)Optional. Immutable. Tags to be bound to the cloned database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
map<string, string> tags = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
setDatabaseId(String value)
public CloneDatabaseRequest.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 |
CloneDatabaseRequest.Builder |
This builder for chaining. |
setDatabaseIdBytes(ByteString value)
public CloneDatabaseRequest.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 |
CloneDatabaseRequest.Builder |
This builder for chaining. |
setEncryptionConfig(Database.EncryptionConfig value)
public CloneDatabaseRequest.Builder setEncryptionConfig(Database.EncryptionConfig value)Optional. Encryption configuration for the cloned database.
If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
.google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Database.EncryptionConfig |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
setEncryptionConfig(Database.EncryptionConfig.Builder builderForValue)
public CloneDatabaseRequest.Builder setEncryptionConfig(Database.EncryptionConfig.Builder builderForValue)Optional. Encryption configuration for the cloned database.
If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
.google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Database.EncryptionConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public CloneDatabaseRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
setParent(String value)
public CloneDatabaseRequest.Builder setParent(String value) Required. The project to clone 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 |
CloneDatabaseRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public CloneDatabaseRequest.Builder setParentBytes(ByteString value) Required. The project to clone 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 |
CloneDatabaseRequest.Builder |
This builder for chaining. |
setPitrSnapshot(PitrSnapshot value)
public CloneDatabaseRequest.Builder setPitrSnapshot(PitrSnapshot value)Required. Specification of the PITR data to clone from. The source database must exist.
The cloned database will be created in the same location as the source database.
.google.firestore.admin.v1.PitrSnapshot pitr_snapshot = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
PitrSnapshot |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
setPitrSnapshot(PitrSnapshot.Builder builderForValue)
public CloneDatabaseRequest.Builder setPitrSnapshot(PitrSnapshot.Builder builderForValue)Required. Specification of the PITR data to clone from. The source database must exist.
The cloned database will be created in the same location as the source database.
.google.firestore.admin.v1.PitrSnapshot pitr_snapshot = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
PitrSnapshot.Builder |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CloneDatabaseRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CloneDatabaseRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CloneDatabaseRequest.Builder |
|