Google Cloud Bigtable Administration v2 API - Class Backup (3.29.0) 

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

Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class Backup.

A backup of a Cloud Bigtable table.

Inheritance

object > Backup

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.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

BackupType

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

Indicates the backup type of the backup.

Property Value
Type Description
BackupTypesBackupType

EncryptionInfo

public EncryptionInfo EncryptionInfo { get; set; }

Output only. The encryption information for the backup.

Property Value
Type Description
EncryptionInfo

EndTime

public Timestamp EndTime { get; set; }

Output only. end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.

Property Value
Type Description
Timestamp

ExpireTime

public Timestamp ExpireTime { get; set; }

Required. The expiration time of the backup. When creating a backup or updating its expire_time, the value must be greater than the backup creation time by:

  • At least 6 hours
  • At most 90 days

Once the expire_time has passed, Cloud Bigtable will delete the backup.

Property Value
Type Description
Timestamp

HotToStandardTime

public Timestamp HotToStandardTime { get; set; }

The time at which the hot backup will be converted to a standard backup. Once the hot_to_standard_time has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by:

  • At least 24 hours

This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.

Property Value
Type Description
Timestamp

Name

public string Name { get; set; }

A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]* The final segment of the name must be between 1 and 50 characters in length.

The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Property Value
Type Description
string

SizeBytes

public long SizeBytes { get; set; }

Output only. Size of the backup in bytes.

Property Value
Type Description
long

SourceBackup

public string SourceBackup { get; set; }

Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>

Property Value
Type Description
string

SourceTable

public string SourceTable { get; set; }

Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/{project}/instances/{instance}/tables/{source_table}.

Property Value
Type Description
string

StartTime

public Timestamp StartTime { get; set; }

Output only. start_time is the time that the backup was started (i.e. approximately the time the [CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup] request is received). The row data in this backup will be no older than this timestamp.

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