Pinecone TypeScript SDK - v9.0.0
    Preparing search index...

    Interface BackupModel

    The configuration and status of a backup.

    Backups

    interface BackupModel {
        backupId: string;
        cloud: string;
        createdAt?: Date;
        description?: string;
        name?: string;
        namespaceCount?: number;
        recordCount?: number;
        region: string;
        schema?: IndexSchema;
        sizeBytes?: number;
        sourceIndexDeletedAt?: Date;
        sourceIndexId: string;
        sourceIndexName: string;
        status: BackupStatus;
        tags?: { [key: string]: string } | null;
    }

    Hierarchy

    • Omit<GeneratedBackupModel, "status" | "schema">
      • BackupModel
    Index
    backupId cloud createdAt? description? name? namespaceCount? recordCount? region schema? sizeBytes? sourceIndexDeletedAt? sourceIndexId sourceIndexName status tags?
    backupId: string

    Unique identifier for the backup.

    BackupModel

    cloud: string

    Cloud provider where the backup is stored.

    BackupModel

    createdAt?: Date

    Timestamp when the backup was created.

    BackupModel

    description?: string

    Optional description providing context for the backup.

    BackupModel

    name?: string

    Optional user-defined name for the backup.

    BackupModel

    namespaceCount?: number

    Number of namespaces in the backup.

    BackupModel

    recordCount?: number

    Total number of records in the backup.

    BackupModel

    region: string

    Cloud region where the backup is stored.

    BackupModel

    schema?: IndexSchema

    The schema of the index the backup was taken from.

    sizeBytes?: number

    Size of the backup in bytes.

    BackupModel

    sourceIndexDeletedAt?: Date

    The deletion timestamp when the source index has been deleted. Not present for backups associated with an active index.

    BackupModel

    sourceIndexId: string

    ID of the index from which the backup was taken.

    BackupModel

    sourceIndexName: string

    Name of the index from which the backup was taken.

    BackupModel

    status: BackupStatus

    The current status of the backup.

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

    Custom user tags added to an index, at most 20 per index. Keys must be 80 characters or less and alphanumeric, '_', or '-'. Values must be 120 characters or less and consist of printable ASCII characters or spaces. To unset a key, set the value to be an empty string. null in responses when the index has no tags.

    BackupModel

    Settings
    Member Visibility

    On This Page
    Properties