Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1RestoreDatabaseRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

The request message for FirestoreAdmin.RestoreDatabase.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1RestoreDatabaseRequest

Returns a new instance of GoogleFirestoreAdminV1RestoreDatabaseRequest.



2502
2503
2504
# File 'lib/google/apis/firestore_v1/classes.rb', line 2502

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#backupString

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` Corresponds to the JSON propertybackup`

Returns:

  • (String)


2484
2485
2486
# File 'lib/google/apis/firestore_v1/classes.rb', line 2484

def backup
  @backup
end

#database_idString

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-/ 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. Corresponds to the JSON property databaseId

Returns:

  • (String)


2494
2495
2496
# File 'lib/google/apis/firestore_v1/classes.rb', line 2494

def database_id
  @database_id
end

#encryption_configGoogle::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig

Encryption configuration for a new database being created from another source. The source could be a Backup or a DatabaseSnapshot. Corresponds to the JSON property encryptionConfig



2500
2501
2502
# File 'lib/google/apis/firestore_v1/classes.rb', line 2500

def encryption_config
  @encryption_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2507
2508
2509
2510
2511
# File 'lib/google/apis/firestore_v1/classes.rb', line 2507

def update!(**args)
  @backup = args[:backup] if args.key?(:backup)
  @database_id = args[:database_id] if args.key?(:database_id)
  @encryption_config = args[:encryption_config] if args.key?(:encryption_config)
end