Interface PreviewIndexModel

The IndexModel describes the configuration and status of a Pinecone index.

Export

IndexModel

interface PreviewIndexModel {
    cmekId?: string;
    deletionProtection: string;
    deployment: PreviewIndexDeployment;
    host: string;
    name: string;
    privateHost?: string;
    readCapacity?: PreviewReadCapacityResponse;
    schema: PreviewIndexSchema;
    sourceBackupId?: string;
    sourceCollection?: string;
    status: PreviewIndexModelStatus;
    tags?: { [key: string]: string };
}

Properties

cmekId? deletionProtection deployment host name privateHost? readCapacity? schema sourceBackupId? sourceCollection? status tags?

Properties

OptionalcmekId

cmekId?: string

The ID of the customer-managed encryption key (CMEK) used to encrypt this index, if any.

Memberof

IndexModel

deletionProtection

deletionProtection: string

Whether deletion protection is enabled/disabled for the index. Possible values: disabled or enabled.

Memberof

IndexModel

deployment

deployment: PreviewIndexDeployment

Memberof

IndexModel

host

host: string

The URL address where the index is hosted.

Memberof

IndexModel

name

name: string

The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

Memberof

IndexModel

OptionalprivateHost

privateHost?: string

The private endpoint URL of an index.

Memberof

IndexModel

OptionalreadCapacity

readCapacity?: PreviewReadCapacityResponse

Memberof

IndexModel

schema

schema: PreviewIndexSchema

Memberof

IndexModel

OptionalsourceBackupId

sourceBackupId?: string

The ID of the backup this index was restored from, if any.

Memberof

IndexModel

OptionalsourceCollection

sourceCollection?: string

The name of the collection this index was created from, if any.

Memberof

IndexModel

status

status: PreviewIndexModelStatus

Memberof

IndexModel

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

IndexModel

Settings

Member Visibility

On This Page

Properties