Firestore Admin v1 API - Class Database (3.11.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.

Inheritance

object > Database

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

CmekConfig

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

Optional. Presence indicates CMEK is enabled for this database.

Property Value
Type Description
DatabaseTypesCmekConfig

ConcurrencyMode

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

The concurrency control mode to use for this database.

Property Value
Type Description
DatabaseTypesConcurrencyMode

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time.

Property Value
Type Description
Timestamp

DatabaseName

public DatabaseName DatabaseName { get; set; }

DatabaseName-typed view over the Name resource name property.

Property Value
Type Description
DatabaseName

DeleteProtectionState

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

State of delete protection for the database.

Property Value
Type Description
DatabaseTypesDeleteProtectionState

DeleteTime

public Timestamp DeleteTime { get; set; }

Output only. The timestamp at which this database was deleted. Only set if the database has been deleted.

Property Value
Type Description
Timestamp

EarliestVersionTime

public Timestamp EarliestVersionTime { get; set; }

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.

Property Value
Type Description
Timestamp

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 locations 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

PointInTimeRecoveryEnablement

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

Whether to enable the PITR feature on this database.

Property Value
Type Description
DatabaseTypesPointInTimeRecoveryEnablement

PreviousId

public string PreviousId { get; set; }

Output only. The database resource's prior database ID. This field is only populated for deleted databases.

Property Value
Type Description
string

SourceInfo

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

Output only. Information about the provenance of this database.

Property Value
Type Description
DatabaseTypesSourceInfo

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

Uid

public string Uid { get; set; }

Output only. The system-generated UUID4 for this Database.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

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.

Property Value
Type Description
Timestamp

VersionRetentionPeriod

public Duration VersionRetentionPeriod { get; set; }

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.

Property Value
Type Description
Duration