Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::Database (v0.6.0)

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

A Cloud Firestore Database. Currently only one database is allowed per cloud project; this database must have a database_id of '(default)'.

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

#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

#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 databases 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 databases are listed at https://cloud.google.com/firestore/docs/locations.
Returns
  • (::String) — The location of the database. Available databases 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}

#type

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

#type=

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