Backup

import type { Backup } from "https://googleapis.deno.dev/v1/alloydb:v1.ts";

Message describing Backup object

interface Backup {

annotations?: {

[key: string]: string;

};

clusterName?: string;

readonly clusterUid?: string;

readonly createTime?: Date;

readonly databaseVersion?:

| "DATABASE_VERSION_UNSPECIFIED"

| "POSTGRES_13"

| "POSTGRES_14"

| "POSTGRES_15";

readonly deleteTime?: Date;

description?: string;

displayName?: string;

encryptionConfig?: EncryptionConfig;

readonly encryptionInfo?: EncryptionInfo;

etag?: string;

readonly expiryQuantity?: QuantityBasedExpiry;

readonly expiryTime?: Date;

labels?: {

[key: string]: string;

};

readonly name?: string;

readonly reconciling?: boolean;

readonly satisfiesPzs?: boolean;

readonly sizeBytes?: bigint;

readonly state?:

| "STATE_UNSPECIFIED"

| "READY"

| "CREATING"

| "FAILED"

| "DELETING";

type?:

| "TYPE_UNSPECIFIED"

| "ON_DEMAND"

| "AUTOMATED"

| "CONTINUOUS";

readonly uid?: string;

readonly updateTime?: Date;

}

§Properties

annotations?: {

[key: string]: string;

}

[src]

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

clusterName?: string

[src]

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

readonly clusterUid?: string

[src]

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

readonly createTime?: Date

[src]

Output only. Create time stamp

readonly databaseVersion?: "DATABASE_VERSION_UNSPECIFIED" | "POSTGRES_13" | "POSTGRES_14" | "POSTGRES_15"

[src]

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.

readonly deleteTime?: Date

[src]

Output only. Delete time stamp

description?: string

[src]

User-provided description of the backup.

displayName?: string

[src]

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

encryptionConfig?: EncryptionConfig

[src]

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.

readonly encryptionInfo?: EncryptionInfo

[src]

Output only. The encryption information for the backup.

etag?: string

[src]

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

readonly expiryQuantity?: QuantityBasedExpiry

[src]

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.

readonly expiryTime?: Date

[src]

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.

labels?: {

[key: string]: string;

}

[src]

Labels as key value pairs

readonly name?: string

[src]

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}

readonly reconciling?: boolean

[src]

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.

readonly satisfiesPzs?: boolean

[src]

Output only. Reserved for future use.

readonly sizeBytes?: bigint

[src]

Output only. The size of the backup in bytes.

readonly state?: "STATE_UNSPECIFIED" | "READY" | "CREATING" | "FAILED" | "DELETING"

[src]

Output only. The current state of the backup.

type?: "TYPE_UNSPECIFIED" | "ON_DEMAND" | "AUTOMATED" | "CONTINUOUS"

[src]

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

readonly uid?: string

[src]

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.

readonly updateTime?: Date

[src]

Output only. Update time stamp