Package com.google.firestore.admin.v1

Class RestoreDatabaseRequest.Builder

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

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

    • internalGetMutableMapFieldReflection

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

    • internalGetFieldAccessorTable

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

    • clear

      public RestoreDatabaseRequest.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<RestoreDatabaseRequest.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<RestoreDatabaseRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public RestoreDatabaseRequest.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<RestoreDatabaseRequest.Builder>

    • mergeFrom

      public RestoreDatabaseRequest.Builder mergeFrom(RestoreDatabaseRequest other)

    • isInitialized

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

    • mergeFrom

      public RestoreDatabaseRequest.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<RestoreDatabaseRequest.Builder>
      Throws:
      IOException

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

    • getParentBytes

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

    • setParent

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

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

    • setParentBytes

      public RestoreDatabaseRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }
      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 RestoreDatabaseRequestOrBuilder
      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 RestoreDatabaseRequestOrBuilder
      Returns:
      The bytes for databaseId.

    • setDatabaseId

      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][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 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][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 RestoreDatabaseRequest.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.

    • 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) = { ... }
      Specified by:
      getBackup in interface RestoreDatabaseRequestOrBuilder
      Returns:
      The backup.

    • getBackupBytes

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

    • setBackup

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

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

    • setBackupBytes

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

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

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

    • setEncryptionConfig

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

    • setEncryptionConfig

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

    • mergeEncryptionConfig

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

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

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

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

    • getTagsCount

      public int getTagsCount()
      Description copied from interface: RestoreDatabaseRequestOrBuilder
       Optional. Immutable. Tags to be bound to the restored database.

 The tags should be provided in the format of
 `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
      map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTagsCount in interface RestoreDatabaseRequestOrBuilder

    • containsTags

      public boolean containsTags(String key)
       Optional. Immutable. Tags to be bound to the restored database.

 The tags should be provided in the format of
 `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
      map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsTags in interface RestoreDatabaseRequestOrBuilder

    • getTags

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

    • getTagsMap

      public Map<String,String> getTagsMap()
       Optional. Immutable. Tags to be bound to the restored database.

 The tags should be provided in the format of
 `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
      map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTagsMap in interface RestoreDatabaseRequestOrBuilder

    • getTagsOrDefault

      public String getTagsOrDefault(String key, String defaultValue)
       Optional. Immutable. Tags to be bound to the restored database.

 The tags should be provided in the format of
 `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
      map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTagsOrDefault in interface RestoreDatabaseRequestOrBuilder

    • getTagsOrThrow

      public String getTagsOrThrow(String key)
       Optional. Immutable. Tags to be bound to the restored database.

 The tags should be provided in the format of
 `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
      map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTagsOrThrow in interface RestoreDatabaseRequestOrBuilder

    • clearTags

      public RestoreDatabaseRequest.Builder clearTags()

    • removeTags

      public RestoreDatabaseRequest.Builder removeTags(String key)
       Optional. Immutable. Tags to be bound to the restored database.

 The tags should be provided in the format of
 `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
      map<string, string> tags = 10 [(.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 RestoreDatabaseRequest.Builder putTags(String key, String value)
       Optional. Immutable. Tags to be bound to the restored database.

 The tags should be provided in the format of
 `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
      map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

    • putAllTags

      public RestoreDatabaseRequest.Builder putAllTags(Map<String,String> values)
       Optional. Immutable. Tags to be bound to the restored database.

 The tags should be provided in the format of
 `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
      map<string, string> tags = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];