Package com.google.firestore.admin.v1

Interface RestoreDatabaseRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RestoreDatabaseRequest, RestoreDatabaseRequest.Builder
@Generated public interface RestoreDatabaseRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getParent

      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) = { ... }
      Returns:
      The parent.

    • getParentBytes

      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) = { ... }
      Returns:
      The bytes for parent.

    • getDatabaseId

      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];
      Returns:
      The databaseId.

    • getDatabaseIdBytes

      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];
      Returns:
      The bytes for databaseId.

    • getBackup

      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) = { ... }
      Returns:
      The backup.

    • getBackupBytes

      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) = { ... }
      Returns:
      The bytes for backup.

    • hasEncryptionConfig

      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];
      Returns:
      Whether the encryptionConfig field is set.

    • getEncryptionConfig

      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];
      Returns:
      The encryptionConfig.

    • getEncryptionConfigOrBuilder

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

    • getTagsCount

      int getTagsCount()
       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];

    • containsTags

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

    • getTags

      @Deprecated Map<String,String> getTags()
      Deprecated.
      Use getTagsMap() instead.

    • getTagsMap

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

    • getTagsOrDefault

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

    • getTagsOrThrow

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