Type Alias FetchByMetadataOptions

The options that may be passed to Index.fetchByMetadata

type FetchByMetadataOptions = {
    filter: object;
    limit?: number;
    namespace?: string;
    paginationToken?: string;
}

Properties

filter: object

The metadata filter to apply when fetching records. Only records matching this filter will be returned.

limit?: number

The maximum number of records to return. If unspecified, the server will use a default value.

namespace?: string

The namespace to fetch from. If not specified, uses the namespace configured on the Index.

paginationToken?: string

A token needed to fetch the next page of results. This token is returned in the response if additional results are available.