Type Alias FetchByMetadataOptions

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

The options that may be passed to Index.fetchByMetadata

Type declaration

  • filter: object

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

  • Optionallimit?: number

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

  • Optionalnamespace?: string

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

  • OptionalpaginationToken?: string

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