Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest (v1.8.0)

Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest.

The request message for FirestoreAdmin.RestoreDatabase.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#backup

def backup() -> ::String
Returns
  • (::String) — 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}

#backup=

def backup=(value) -> ::String
Parameter
  • value (::String) — 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}

Returns
  • (::String) — 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}

#database_id

def database_id() -> ::String
Returns
  • (::String) — 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.

#database_id=

def database_id=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#encryption_config

def encryption_config() -> ::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig
Returns

#encryption_config=

def encryption_config=(value) -> ::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig
Parameter
Returns

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The project to restore the database in. Format is projects/{project_id}.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The project to restore the database in. Format is projects/{project_id}.
Returns
  • (::String) — Required. The project to restore the database in. Format is projects/{project_id}.

#tags

def tags() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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}.

#tags=

def tags=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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}.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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}.