Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::Database (v1.2.0)

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

A Cloud Firestore Database.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#app_engine_integration_mode

def app_engine_integration_mode() -> ::Google::Cloud::Firestore::Admin::V1::Database::AppEngineIntegrationMode
Returns

#app_engine_integration_mode=

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

#cmek_config

def cmek_config() -> ::Google::Cloud::Firestore::Admin::V1::Database::CmekConfig
Returns

#cmek_config=

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

#concurrency_mode

def concurrency_mode() -> ::Google::Cloud::Firestore::Admin::V1::Database::ConcurrencyMode
Returns

#concurrency_mode=

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

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time.

#delete_protection_state

def delete_protection_state() -> ::Google::Cloud::Firestore::Admin::V1::Database::DeleteProtectionState
Returns

#delete_protection_state=

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

#delete_time

def delete_time() -> ::Google::Protobuf::Timestamp
Returns

#earliest_version_time

def earliest_version_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period.

    This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.

#etag

def etag() -> ::String
Returns
  • (::String) — This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Returns
  • (::String) — This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

#key_prefix

def key_prefix() -> ::String
Returns
  • (::String) — Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("

#location_id

def location_id() -> ::String
Returns
  • (::String) — The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.

#location_id=

def location_id=(value) -> ::String
Parameter
  • value (::String) — The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
Returns
  • (::String) — The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.

#name

def name() -> ::String
Returns
  • (::String) — The resource name of the Database. Format: projects/{project}/databases/{database}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The resource name of the Database. Format: projects/{project}/databases/{database}
Returns
  • (::String) — The resource name of the Database. Format: projects/{project}/databases/{database}

#point_in_time_recovery_enablement

def point_in_time_recovery_enablement() -> ::Google::Cloud::Firestore::Admin::V1::Database::PointInTimeRecoveryEnablement
Returns

#point_in_time_recovery_enablement=

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

#previous_id

def previous_id() -> ::String
Returns
  • (::String) — Output only. The database resource's prior database ID. This field is only populated for deleted databases.

#source_info

def source_info() -> ::Google::Cloud::Firestore::Admin::V1::Database::SourceInfo
Returns

#type

def type() -> ::Google::Cloud::Firestore::Admin::V1::Database::DatabaseType
Returns

#type=

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

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. The system-generated UUID4 for this Database.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.

#version_retention_period

def version_retention_period() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — Output only. The period during which past versions of data are retained in the database.

    Any [read][google.firestore.v1.GetDocumentRequest.read_time] or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify a read_time within this window, and will read the state of the database at that time.

    If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour.