Interface PreviewBackupModel

The BackupModel describes the configuration and status of a Pinecone backup.

Export

BackupModel

interface PreviewBackupModel {
    backupId: string;
    cloud: string;
    createdAt?: Date;
    description?: string;
    name?: string;
    namespaceCount?: number;
    recordCount?: number;
    region: string;
    schema?: PreviewIndexSchema;
    sizeBytes?: number;
    sourceIndexId: string;
    sourceIndexName: string;
    status: string;
    tags?: { [key: string]: string };
}

Properties

backupId cloud createdAt? description? name? namespaceCount? recordCount? region schema? sizeBytes? sourceIndexId sourceIndexName status tags?

Properties

backupId

backupId: string

Unique identifier for the backup.

Memberof

BackupModel

cloud

cloud: string

Cloud provider where the backup is stored.

Memberof

BackupModel

OptionalcreatedAt

createdAt?: Date

Timestamp when the backup was created.

Memberof

BackupModel

Optionaldescription

description?: string

Optional description providing context for the backup.

Memberof

BackupModel

Optionalname

name?: string

Optional user-defined name for the backup.

Memberof

BackupModel

OptionalnamespaceCount

namespaceCount?: number

Number of namespaces in the backup.

Memberof

BackupModel

OptionalrecordCount

recordCount?: number

Total number of records in the backup.

Memberof

BackupModel

region

region: string

Cloud region where the backup is stored.

Memberof

BackupModel

Optionalschema

schema?: PreviewIndexSchema

Memberof

BackupModel

OptionalsizeBytes

sizeBytes?: number

Size of the backup in bytes.

Memberof

BackupModel

sourceIndexId

sourceIndexId: string

ID of the index from which the backup was taken.

Memberof

BackupModel

sourceIndexName

sourceIndexName: string

Name of the index from which the backup was taken.

Memberof

BackupModel

status

status: string

Current status of the backup.

Memberof

BackupModel

Optionaltags

tags?: { [key: string]: string }

Custom user tags added to an index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '', or '-'. Values must be alphanumeric, ';', '@', '', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.

Memberof

BackupModel

Settings

Member Visibility

On This Page

Properties