Class Backup

Message describing Backup object

Inheritance

object

Backup

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.CloudAlloyDBAdmin.v1beta.Data

Assembly: Google.Apis.CloudAlloyDBAdmin.v1beta.dll

Syntax

public class Backup : IDirectResponseSchema

Properties

Annotations

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

Declaration

[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }

Property Value

Type	Description
IDictionary<string, string>

ClusterName

Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

Declaration

[JsonProperty("clusterName")]
public virtual string ClusterName { get; set; }

Property Value

Type	Description
string

ClusterUid

Output only. The system-generated UID of the cluster which was used to create this resource.

Declaration

[JsonProperty("clusterUid")]
public virtual string ClusterUid { get; set; }

Property Value

Type	Description
string

CreateCompletionTime

object representation of CreateCompletionTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateCompletionTimeDateTimeOffset instead.")]
public virtual object CreateCompletionTime { get; set; }

Property Value

Type	Description
object

CreateCompletionTimeDateTimeOffset

DateTimeOffset representation of CreateCompletionTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateCompletionTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateCompletionTimeRaw

Output only. Timestamp when the resource finished being created.

Declaration

[JsonProperty("createCompletionTime")]
public virtual string CreateCompletionTimeRaw { 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. Create time stamp

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

DatabaseVersion

Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.

Declaration

[JsonProperty("databaseVersion")]
public virtual string DatabaseVersion { 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. Delete time stamp

Declaration

[JsonProperty("deleteTime")]
public virtual string DeleteTimeRaw { get; set; }

Property Value

Type	Description
string

Description

User-provided description of the backup.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

DisplayName

User-settable and human-readable display name for the Backup.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

For Resource freshness validation (https://google.aip.dev/154)

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

EncryptionConfig

Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

Declaration

[JsonProperty("encryptionConfig")]
public virtual EncryptionConfig EncryptionConfig { get; set; }

Property Value

Type	Description
EncryptionConfig

EncryptionInfo

Output only. The encryption information for the backup.

Declaration

[JsonProperty("encryptionInfo")]
public virtual EncryptionInfo EncryptionInfo { get; set; }

Property Value

Type	Description
EncryptionInfo

ExpiryQuantity

Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

Declaration

[JsonProperty("expiryQuantity")]
public virtual QuantityBasedExpiry ExpiryQuantity { get; set; }

Property Value

Type	Description
QuantityBasedExpiry

ExpiryTime

object representation of ExpiryTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpiryTimeDateTimeOffset instead.")]
public virtual object ExpiryTime { get; set; }

Property Value

Type	Description
object

ExpiryTimeDateTimeOffset

DateTimeOffset representation of ExpiryTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? ExpiryTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

ExpiryTimeRaw

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

Declaration

[JsonProperty("expiryTime")]
public virtual string ExpiryTimeRaw { get; set; }

Property Value

Type	Description
string

Labels

Labels as key value pairs

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Name

Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Reconciling

Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.

Declaration

[JsonProperty("reconciling")]
public virtual bool? Reconciling { get; set; }

Property Value

Type	Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }

Property Value

Type	Description
bool?

SizeBytes

Output only. The size of the backup in bytes.

Declaration

[JsonProperty("sizeBytes")]
public virtual long? SizeBytes { get; set; }

Property Value

Type	Description
long?

State

Output only. The current state of the backup.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

Type

The backup type, which suggests the trigger for the backup.

Declaration

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

Property Value

Type	Description
string

Uid

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

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. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema