public final class CloneDatabaseRequest extends GeneratedMessageV3 implements CloneDatabaseRequestOrBuilder
The request message for
FirestoreAdmin.CloneDatabase.
Protobuf type google.firestore.admin.v1.CloneDatabaseRequest
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
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 |
|
PITR_SNAPSHOT_FIELD_NUMBER
public static final int PITR_SNAPSHOT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TAGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CloneDatabaseRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CloneDatabaseRequest.Builder newBuilder()
newBuilder(CloneDatabaseRequest prototype)
public static CloneDatabaseRequest.Builder newBuilder(CloneDatabaseRequest prototype)
public static CloneDatabaseRequest parseDelimitedFrom(InputStream input)
public static CloneDatabaseRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CloneDatabaseRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CloneDatabaseRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CloneDatabaseRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CloneDatabaseRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CloneDatabaseRequest parseFrom(CodedInputStream input)
public static CloneDatabaseRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CloneDatabaseRequest parseFrom(InputStream input)
public static CloneDatabaseRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CloneDatabaseRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CloneDatabaseRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CloneDatabaseRequest> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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()
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];
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];
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.
|
getParserForType()
public Parser<CloneDatabaseRequest> getParserForType()
Overrides
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];
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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public Map<String,String> getTags()
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 |
|
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];
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];
| Returns |
| Type |
Description |
String |
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CloneDatabaseRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CloneDatabaseRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CloneDatabaseRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
