Package com.google.firestore.admin.v1

Class CloneDatabaseRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CloneDatabaseRequest.Builder>
com.google.firestore.admin.v1.CloneDatabaseRequest.Builder
All Implemented Interfaces:
CloneDatabaseRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CloneDatabaseRequest
public static final class CloneDatabaseRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<CloneDatabaseRequest.Builder> implements CloneDatabaseRequestOrBuilder
 The request message for
 [FirestoreAdmin.CloneDatabase][google.firestore.admin.v1.FirestoreAdmin.CloneDatabase].
Protobuf type google.firestore.admin.v1.CloneDatabaseRequest

  • 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.Builder<CloneDatabaseRequest.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<CloneDatabaseRequest.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<CloneDatabaseRequest.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<CloneDatabaseRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public CloneDatabaseRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CloneDatabaseRequest.Builder>

    • mergeFrom

      public CloneDatabaseRequest.Builder mergeFrom(CloneDatabaseRequest other)

    • isInitialized

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

    • mergeFrom

      public CloneDatabaseRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CloneDatabaseRequest.Builder>
      Throws:
      IOException

    • 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.

    • setParent

      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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setParentBytes

      public CloneDatabaseRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDatabaseId

      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][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];
      Parameters:
      value - The databaseId to set.
      Returns:
      This builder for chaining.

    • 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][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];
      Returns:
      This builder for chaining.

    • setDatabaseIdBytes

      public CloneDatabaseRequest.Builder setDatabaseIdBytes(com.google.protobuf.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][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];
      Parameters:
      value - The bytes for databaseId to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPitrSnapshot

      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];

    • setPitrSnapshot

      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];

    • mergePitrSnapshot

      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];

    • 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];

    • 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];

    • 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.

    • setEncryptionConfig

      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.use_source_encryption].
      .google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

    • setEncryptionConfig

      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.use_source_encryption].
      .google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

    • mergeEncryptionConfig

      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.use_source_encryption].
      .google.firestore.admin.v1.Database.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

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

    • 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.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.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

    • clearTags

      public CloneDatabaseRequest.Builder clearTags()

    • removeTags

      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];

    • getMutableTags

      @Deprecated public Map<String,String> getMutableTags()
      Deprecated.
      Use alternate mutation accessors instead.

    • putTags

      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];

    • putAllTags

      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];