Firestore Admin v1 API - Class Backup (3.11.0)

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

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

A Backup of a Cloud Firestore Database.

The backup contains all documents and index configurations for the given database at a specific point in time.

Inheritance

object > Backup

Implements

IMessage Backup, IEquatable Backup, IDeepCloneable Backup, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

Backup()

public Backup()

Backup(Backup)

public Backup(Backup other)

Parameter
Name	Description
`other`	`Backup`

Properties

BackupName

public BackupName BackupName { get; set; }

BackupName-typed view over the Name resource name property.

Property Value
Type	Description
`BackupName`

Database

public string Database { get; set; }

Output only. Name of the Firestore database that the backup is from.

Format is projects/{project}/databases/{database}.

Property Value
Type	Description
`string`

DatabaseAsDatabaseName

public DatabaseName DatabaseAsDatabaseName { get; set; }

DatabaseName-typed view over the Database resource name property.

Property Value
Type	Description
`DatabaseName`

DatabaseUid

public string DatabaseUid { get; set; }

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

Property Value
Type	Description
`string`

ExpireTime

public Timestamp ExpireTime { get; set; }

Output only. The timestamp at which this backup expires.

Property Value
Type	Description
`Timestamp`

Name

public string Name { get; set; }

Output only. The unique resource name of the Backup.

Format is projects/{project}/locations/{location}/backups/{backup}.

Property Value
Type	Description
`string`

SnapshotTime

public Timestamp SnapshotTime { get; set; }

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

Property Value
Type	Description
`Timestamp`

State

public Backup.Types.State State { get; set; }

Output only. The current state of the backup.

Property Value
Type	Description
`BackupTypesState`

Stats

public Backup.Types.Stats Stats { get; set; }

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.

Property Value
Type	Description
`BackupTypesStats`