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

    Interface BackupScheduleHistoryItem

    A backup produced by a schedule. A row appears as soon as a run is planned, so status is Scheduled and scheduledExecutionAt is set until the run starts.

    Backups

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

    Hierarchy

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

    Unique identifier for the backup.

    BackupScheduleHistoryItem

    cloud: string

    Cloud provider where the backup is stored.

    BackupScheduleHistoryItem

    createdAt: Date

    RFC 3339 timestamp when the backup record was created.

    BackupScheduleHistoryItem

    description?: string | null

    Optional description of the backup, or null.

    BackupScheduleHistoryItem

    name: string

    Name of the backup.

    BackupScheduleHistoryItem

    namespaceCount?: number | null

    Number of namespaces in the backup. null until the backup reaches status Ready.

    BackupScheduleHistoryItem

    recordCount?: number | null

    Total number of records in the backup. null until the backup reaches status Ready.

    BackupScheduleHistoryItem

    region: string

    Cloud region where the backup is stored.

    BackupScheduleHistoryItem

    scheduledExecutionAt?: Date

    Present when status is Scheduled. RFC 3339 timestamp when the backup is planned to run.

    BackupScheduleHistoryItem

    schema?: IndexSchema | null

    The schema of the index the backup was taken from.

    sizeBytes?: number | null

    Approximate stored size of this scheduled-backup snapshot, in bytes. null until the backup reaches status Ready.

    BackupScheduleHistoryItem

    sourceIndexId: string

    ID of the index from which the backup was taken.

    BackupScheduleHistoryItem

    sourceIndexName: string

    Name of the index from which the backup was taken.

    BackupScheduleHistoryItem

    status: ScheduledBackupStatus

    The current status of the backup.

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

    Custom user tags on this backup snapshot. 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. null when no tags are set.

    BackupScheduleHistoryItem

    Settings
    Member Visibility

    On This Page
    Properties