Show / Hide Table of Contents

Class GoogleFirestoreAdminV1Backup

A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at specific point in time.

Inheritance
object
GoogleFirestoreAdminV1Backup
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Firestore.v1.Data
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class GoogleFirestoreAdminV1Backup : IDirectResponseSchema

Properties

Database

Output only. Name of the Firestore database that the backup is from. Format is projects/{project}/databases/{database}.

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

DatabaseUid

Output only. The system-generated UUID4 for the Firestore database that the backup is from.

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

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExpireTime

object representation of ExpireTimeRaw.

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

ExpireTimeDateTimeOffset

DateTimeOffset representation of ExpireTimeRaw.

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

ExpireTimeRaw

Output only. The timestamp at which this backup expires.

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

Name

Output only. The unique resource name of the Backup. Format is projects/{project}/locations/{location}/backups/{backup}.

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

SnapshotTime

object representation of SnapshotTimeRaw.

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

SnapshotTimeDateTimeOffset

DateTimeOffset representation of SnapshotTimeRaw.

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

SnapshotTimeRaw

Output only. The backup contains an externally consistent copy of the database at this time.

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

State

Output only. The current state of the backup.

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

Stats

Output only. Statistics about the backup. This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.

Declaration
[JsonProperty("stats")]
public virtual GoogleFirestoreAdminV1Stats Stats { get; set; }
Property Value
Type Description
GoogleFirestoreAdminV1Stats

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX