Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::CloneDatabaseRequest.
The request message for FirestoreAdmin.CloneDatabase.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#database_id
def database_id() -> ::String-
(::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-
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.
-
(::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-
(::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig) — Optional. Encryption configuration for the cloned database.
If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
#encryption_config=
def encryption_config=(value) -> ::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig-
value (::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig) — Optional. Encryption configuration for the cloned database.
If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
-
(::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig) — Optional. Encryption configuration for the cloned database.
If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
#parent
def parent() -> ::String-
(::String) — Required. The project to clone the database in. Format is
projects/{project_id}.
#parent=
def parent=(value) -> ::String-
value (::String) — Required. The project to clone the database in. Format is
projects/{project_id}.
-
(::String) — Required. The project to clone the database in. Format is
projects/{project_id}.
#pitr_snapshot
def pitr_snapshot() -> ::Google::Cloud::Firestore::Admin::V1::PitrSnapshot-
(::Google::Cloud::Firestore::Admin::V1::PitrSnapshot) — Required. Specification of the PITR data to clone from. The source database
must exist.
The cloned database will be created in the same location as the source database.
#pitr_snapshot=
def pitr_snapshot=(value) -> ::Google::Cloud::Firestore::Admin::V1::PitrSnapshot-
value (::Google::Cloud::Firestore::Admin::V1::PitrSnapshot) — Required. Specification of the PITR data to clone from. The source database
must exist.
The cloned database will be created in the same location as the source database.
-
(::Google::Cloud::Firestore::Admin::V1::PitrSnapshot) — Required. Specification of the PITR data to clone from. The source database
must exist.
The cloned database will be created in the same location as the source database.
#tags
def tags() -> ::Google::Protobuf::Map{::String => ::String}-
(::Google::Protobuf::Map{::String => ::String}) — Optional. Immutable. Tags to be bound to the cloned 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}-
value (::Google::Protobuf::Map{::String => ::String}) — Optional. Immutable. Tags to be bound to the cloned database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.
-
(::Google::Protobuf::Map{::String => ::String}) — Optional. Immutable. Tags to be bound to the cloned database.
The tags should be provided in the format of
tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.