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.



2458
2459
2460
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2458

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

Instance Attribute Details

#backup ⇒ String

Backup to restore from. Must be from the same project as the parent. Format is: projects/project_id/locations/location/backups/backup` Corresponds to the JSON propertybackup`

Returns:

  • (String) 


2419
2420
2421
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2419

def backup
  @backup
end

#database_id ⇒ 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-/ 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) 


2429
2430
2431
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2429

def database_id
  @database_id
end

#kms_key_name ⇒ String

Use Customer Managed Encryption Keys (CMEK) for encryption. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is projects/project_id/locations/kms_location/keyRings/key_ring/ cryptoKeys/crypto_key`. Corresponds to the JSON propertykmsKeyName`

Returns:

  • (String) 


2440
2441
2442
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2440

def kms_key_name
  @kms_key_name
end

#use_backup_encryption ⇒ Google::Apis::FirestoreV1::Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo rpc Bar(google. protobuf.Empty) returns (google.protobuf.Empty); Corresponds to the JSON property useBackupEncryption

Returns:



2448
2449
2450
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2448

def use_backup_encryption
  @use_backup_encryption
end

#use_google_default_encryption ⇒ Google::Apis::FirestoreV1::Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo rpc Bar(google. protobuf.Empty) returns (google.protobuf.Empty); Corresponds to the JSON property useGoogleDefaultEncryption

Returns:



2456
2457
2458
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2456

def use_google_default_encryption
  @use_google_default_encryption
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2463
2464
2465
2466
2467
2468
2469
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2463

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