Firestore Admin v1 API - Class Database (3.3.0)

public sealed class Database : IMessage<Database>, IEquatable<Database>, IDeepCloneable<Database>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore Admin v1 API class Database.

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

Inheritance

object > Database

Implements

IMessage Database, IEquatable Database, IDeepCloneable Database, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

Database()

public Database()

Database(Database)

public Database(Database other)

Parameter
Name	Description
`other`	`Database`

Properties

AppEngineIntegrationMode

public Database.Types.AppEngineIntegrationMode AppEngineIntegrationMode { get; set; }

The App Engine integration mode to use for this database.

Property Value
Type	Description
`DatabaseTypesAppEngineIntegrationMode`

ConcurrencyMode

public Database.Types.ConcurrencyMode ConcurrencyMode { get; set; }

The concurrency control mode to use for this database.

Property Value
Type	Description
`DatabaseTypesConcurrencyMode`

DatabaseName

public DatabaseName DatabaseName { get; set; }

DatabaseName-typed view over the Name resource name property.

Property Value
Type	Description
`DatabaseName`

Etag

public string Etag { get; set; }

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.

Property Value
Type	Description
`string`

KeyPrefix

public string KeyPrefix { get; set; }

Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id ("<key prefix>~<project id>") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes.

This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).

Property Value
Type	Description
`string`

LocationId

public string LocationId { get; set; }

The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.

Property Value
Type	Description
`string`

Name

public string Name { get; set; }

The resource name of the Database. Format: projects/{project}/databases/{database}

Property Value
Type	Description
`string`

Type

public Database.Types.DatabaseType Type { get; set; }

The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

Property Value
Type	Description
`DatabaseTypesDatabaseType`