Package com.google.firestore.admin.v1

Class CloneDatabaseRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.firestore.admin.v1.CloneDatabaseRequest
All Implemented Interfaces:
CloneDatabaseRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CloneDatabaseRequest extends com.google.protobuf.GeneratedMessage implements CloneDatabaseRequestOrBuilder
 The request message for
 [FirestoreAdmin.CloneDatabase][google.firestore.admin.v1.FirestoreAdmin.CloneDatabase].
Protobuf type google.firestore.admin.v1.CloneDatabaseRequest
See Also:

  • Field Details

    • PARENT_FIELD_NUMBER

      public static final int PARENT_FIELD_NUMBER
      See Also:

    • DATABASE_ID_FIELD_NUMBER

      public static final int DATABASE_ID_FIELD_NUMBER
      See Also:

    • PITR_SNAPSHOT_FIELD_NUMBER

      public static final int PITR_SNAPSHOT_FIELD_NUMBER
      See Also:

    • ENCRYPTION_CONFIG_FIELD_NUMBER

      public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
      See Also:

    • TAGS_FIELD_NUMBER

      public static final int TAGS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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) = { ... }
      Specified by:
      getParent in interface CloneDatabaseRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getParentBytes in interface CloneDatabaseRequestOrBuilder
      Returns:
      The bytes for parent.

    • 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][0-9]-/
 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 if the database is Standard edition.
      string database_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDatabaseId in interface CloneDatabaseRequestOrBuilder
      Returns:
      The databaseId.

    • getDatabaseIdBytes

      public com.google.protobuf.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][0-9]-/
 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 if the database is Standard edition.
      string database_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDatabaseIdBytes in interface CloneDatabaseRequestOrBuilder
      Returns:
      The bytes for databaseId.

    • 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];
      Specified by:
      hasPitrSnapshot in interface CloneDatabaseRequestOrBuilder
      Returns:
      Whether the pitrSnapshot field is set.

    • 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];
      Specified by:
      getPitrSnapshot in interface CloneDatabaseRequestOrBuilder
      Returns:
      The pitrSnapshot.

    • 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];
      Specified by:
      getPitrSnapshotOrBuilder in interface CloneDatabaseRequestOrBuilder

    • 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.use_source_encryption].
      .google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEncryptionConfig in interface CloneDatabaseRequestOrBuilder
      Returns:
      Whether the encryptionConfig field is set.

    • 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.use_source_encryption].
      .google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEncryptionConfig in interface CloneDatabaseRequestOrBuilder
      Returns:
      The encryptionConfig.

    • 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.use_source_encryption].
      .google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEncryptionConfigOrBuilder in interface CloneDatabaseRequestOrBuilder

    • getTagsCount

      public int getTagsCount()
      Description copied from interface: CloneDatabaseRequestOrBuilder
       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];
      Specified by:
      getTagsCount in interface CloneDatabaseRequestOrBuilder

    • containsTags

      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];
      Specified by:
      containsTags in interface CloneDatabaseRequestOrBuilder

    • getTags

      @Deprecated public Map<String,String> getTags()
      Deprecated.
      Use getTagsMap() instead.
      Specified by:
      getTags in interface CloneDatabaseRequestOrBuilder

    • 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];
      Specified by:
      getTagsMap in interface CloneDatabaseRequestOrBuilder

    • getTagsOrDefault

      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];
      Specified by:
      getTagsOrDefault in interface CloneDatabaseRequestOrBuilder

    • getTagsOrThrow

      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];
      Specified by:
      getTagsOrThrow in interface CloneDatabaseRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CloneDatabaseRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CloneDatabaseRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CloneDatabaseRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CloneDatabaseRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CloneDatabaseRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CloneDatabaseRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CloneDatabaseRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CloneDatabaseRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CloneDatabaseRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CloneDatabaseRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CloneDatabaseRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CloneDatabaseRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CloneDatabaseRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static CloneDatabaseRequest.Builder newBuilder()

    • newBuilder

      public static CloneDatabaseRequest.Builder newBuilder(CloneDatabaseRequest prototype)

    • toBuilder

      public CloneDatabaseRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CloneDatabaseRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static CloneDatabaseRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CloneDatabaseRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<CloneDatabaseRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public CloneDatabaseRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder