Index

Hierarchy

  • Index

Index

Properties

Optional checksum

checksum?: string

The checksum of the data being indexed by this index record.

Optional fields

fields?: any

The indexing attributes for the data being indexed by this index record. The attributes must match the indexing attributes defined for the index layer. To get or set the index attributes for an index layer, use the config API.

Optional id

id?: string

The unique identifier (UUID) of the data being indexed by this index record.

Optional metadata

metadata?:

User-defined fields that can store extra metadata about this index record.

Type declaration

  • [key: string]: string

Optional size

size?: number

The size of the data being indexed by this index record.