Package com.google.firestore.admin.v1

Class RestoreDatabaseRequest

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

  • Field Details

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

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

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

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

    • 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

    • 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 RestoreDatabaseRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RestoreDatabaseRequest.Builder newBuilder()

    • newBuilder

      public static RestoreDatabaseRequest.Builder newBuilder(RestoreDatabaseRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RestoreDatabaseRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RestoreDatabaseRequest> 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 RestoreDatabaseRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder