Class GoogleFirestoreAdminV1Database

A Cloud Firestore Database.

Inheritance
object
GoogleFirestoreAdminV1Database
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1.Data
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class GoogleFirestoreAdminV1Database : IDirectResponseSchema

Properties

AppEngineIntegrationMode

The App Engine integration mode to use for this database.

Declaration
[JsonProperty("appEngineIntegrationMode")]
public virtual string AppEngineIntegrationMode { get; set; }
Property Value
Type Description
string

CmekConfig

Optional. Presence indicates CMEK is enabled for this database.

Declaration
[JsonProperty("cmekConfig")]
public virtual GoogleFirestoreAdminV1CmekConfig CmekConfig { get; set; }
Property Value
Type Description
GoogleFirestoreAdminV1CmekConfig

ConcurrencyMode

The concurrency control mode to use for this database.

Declaration
[JsonProperty("concurrencyMode")]
public virtual string ConcurrencyMode { get; set; }
Property Value
Type Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

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

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DatabaseEdition

Immutable. The edition of the database.

Declaration
[JsonProperty("databaseEdition")]
public virtual string DatabaseEdition { get; set; }
Property Value
Type Description
string

DeleteProtectionState

State of delete protection for the database.

Declaration
[JsonProperty("deleteProtectionState")]
public virtual string DeleteProtectionState { get; set; }
Property Value
Type Description
string

DeleteTime

object representation of DeleteTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeleteTimeDateTimeOffset instead.")]
public virtual object DeleteTime { get; set; }
Property Value
Type Description
object

DeleteTimeDateTimeOffset

DateTimeOffset representation of DeleteTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? DeleteTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

DeleteTimeRaw

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

Declaration
[JsonProperty("deleteTime")]
public virtual string DeleteTimeRaw { get; set; }
Property Value
Type Description
string

ETag

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.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

EarliestVersionTime

object representation of EarliestVersionTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EarliestVersionTimeDateTimeOffset instead.")]
public virtual object EarliestVersionTime { get; set; }
Property Value
Type Description
object

EarliestVersionTimeDateTimeOffset

DateTimeOffset representation of EarliestVersionTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? EarliestVersionTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EarliestVersionTimeRaw

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.

Declaration
[JsonProperty("earliestVersionTime")]
public virtual string EarliestVersionTimeRaw { get; set; }
Property Value
Type Description
string

FreeTier

Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier.

Declaration
[JsonProperty("freeTier")]
public virtual bool? FreeTier { get; set; }
Property Value
Type Description
bool?

KeyPrefix

Output only. The key_prefix for this database. This key_prefix is used, in combination with the 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).

Declaration
[JsonProperty("keyPrefix")]
public virtual string KeyPrefix { get; set; }
Property Value
Type Description
string

LocationId

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

Declaration
[JsonProperty("locationId")]
public virtual string LocationId { get; set; }
Property Value
Type Description
string

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PointInTimeRecoveryEnablement

Whether to enable the PITR feature on this database.

Declaration
[JsonProperty("pointInTimeRecoveryEnablement")]
public virtual string PointInTimeRecoveryEnablement { get; set; }
Property Value
Type Description
string

PreviousId

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

Declaration
[JsonProperty("previousId")]
public virtual string PreviousId { get; set; }
Property Value
Type Description
string

SourceInfo

Output only. Information about the provenance of this database.

Declaration
[JsonProperty("sourceInfo")]
public virtual GoogleFirestoreAdminV1SourceInfo SourceInfo { get; set; }
Property Value
Type Description
GoogleFirestoreAdminV1SourceInfo

Tags

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

Declaration
[JsonProperty("tags")]
public virtual IDictionary<string, string> Tags { get; set; }
Property Value
Type Description
IDictionary<string, string>

Type

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

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

Uid

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

Declaration
[JsonProperty("uid")]
public virtual string Uid { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

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.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

VersionRetentionPeriod

Output only. The period during which past versions of data are retained in the database. Any read or query 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.

Declaration
[JsonProperty("versionRetentionPeriod")]
public virtual object VersionRetentionPeriod { get; set; }
Property Value
Type Description
object

Implements