Class SearchIndex

Class representing an Algolia Search Index.

Hierarchy (View Summary)

HalResource
- SearchIndex

Index

Constructors

constructor

new SearchIndex(data?: any): SearchIndex
Creates a new instance of the resource. If data is provided it will be parsed as if it had come from the remote api.
Parameters
- Optionaldata: any
Returns SearchIndex
Inherited from HalResource.constructor
- Defined in src/lib/hal/models/HalResource.ts:35

Properties

`Optional`_links

_links?: Map<string, HalLink>

`Optional`createdDate

createdDate?: string

Timestamp representing when the Index was originally created.

`Optional`id

id?: string

Unique id generated on creation.

`Optional`label

label?: string

Friendly display label for index.

`Optional`lastModifiedDate

lastModifiedDate?: string

Timestamp representing when the Index was last updated.

`Optional`name

name?: string

Generated index name including the hub name and user defined suffix.

`Optional`parentId

parentId?: string

Id of the replicas parent index (only present on replica indexes).

`Readonly`related

related: {
    assignedContentTypes: {
        create: (resource: AssignedContentType) => Promise<AssignedContentType>;
        get: (id: string) => Promise<AssignedContentType>;
        list: (
            options?: Pageable & Sortable,
        ) => Promise<Page<AssignedContentType>>;
    };
    clear: () => Promise<SearchIndex>;
    delete: () => Promise<void>;
    hub: () => Promise<Hub>;
    indexObject: { delete: (id: string) => Promise<void> };
    keys: { get: () => Promise<SearchIndexKey> };
    "no-results-rate": {
        get: (
            __namedParameters: {
                endDate?: string;
                includeReplicas?: boolean;
                startDate?: string;
                tags?: string;
            },
        ) => Promise<SearchIndexNoResultsRate>;
    };
    replicas: {
        list: (
            projection?: string,
            options?: Pageable & Sortable,
        ) => Promise<Page<SearchIndex>>;
    };
    "searches-count": {
        get: (
            __namedParameters: {
                endDate?: string;
                includeReplicas?: boolean;
                startDate?: string;
                tags?: string;
            },
        ) => Promise<SearchIndexSearchesCount>;
    };
    "searches-with-no-results": {
        get: (
            __namedParameters: {
                endDate?: string;
                includeReplicas?: boolean;
                limit?: number;
                offset?: number;
                startDate?: string;
                tags?: string;
            },
        ) => Promise<SearchIndexSearchesWithNoResultsCollection>;
    };
    settings: {
        get: () => Promise<SearchIndexSettings>;
        update: (
            resource: SearchIndexSettings,
            forwardToReplicas?: boolean,
            options?: { waitUntilApplied: boolean | string[] },
        ) => Promise<SearchIndexSettings>;
    };
    stats: { get: (period?: string) => Promise<SearchIndexStatistics> };
    "top-filters-no-result-search": {
        get: (
            __namedParameters: {
                endDate?: string;
                includeReplicas?: boolean;
                limit?: number;
                offset?: number;
                search: string;
                startDate?: string;
                tags?: string;
            },
        ) => Promise<SearchIndexTopFiltersNoResultSearchCollection>;
    };
    "top-hits": {
        get: (
            __namedParameters: {
                endDate?: string;
                includeReplicas?: boolean;
                limit?: number;
                offset?: number;
                search?: string;
                startDate?: string;
                tags?: string;
            },
        ) => Promise<SearchIndexTopHitsCollection>;
    };
    "top-searches": {
        get: (
            __namedParameters: {
                clickAnalytics?: boolean;
                direction?: "asc" | "desc";
                endDate?: string;
                includeReplicas?: boolean;
                limit?: number;
                offset?: number;
                orderBy?: SearchesOrderBy;
                startDate?: string;
                tags?: string;
            },
        ) => Promise<SearchIndexTopSearchesCollection>;
    };
    update: (resource: SearchIndex) => Promise<SearchIndex>;
    "users-count": {
        get: (
            __namedParameters: {
                endDate?: string;
                includeReplicas?: boolean;
                startDate?: string;
                tags?: string;
            },
        ) => Promise<SearchIndexUsersCount>;
    };
} = ...

Resources and actions related to a Search Index.

Type declaration

assignedContentTypes: {
    create: (resource: AssignedContentType) => Promise<AssignedContentType>;
    get: (id: string) => Promise<AssignedContentType>;
    list: (options?: Pageable & Sortable) => Promise<Page<AssignedContentType>>;
}
clear: () => Promise<SearchIndex>
delete: () => Promise<void>
hub: () => Promise<Hub>
Retrieves the Hub this search index is stored in
indexObject: { delete: (id: string) => Promise<void> }
keys: { get: () => Promise<SearchIndexKey> }
no-results-rate: {
    get: (
        __namedParameters: {
            endDate?: string;
            includeReplicas?: boolean;
            startDate?: string;
            tags?: string;
        },
    ) => Promise<SearchIndexNoResultsRate>;
}
replicas: {
    list: (
        projection?: string,
        options?: Pageable & Sortable,
    ) => Promise<Page<SearchIndex>>;
}
searches-count: {
    get: (
        __namedParameters: {
            endDate?: string;
            includeReplicas?: boolean;
            startDate?: string;
            tags?: string;
        },
    ) => Promise<SearchIndexSearchesCount>;
}
searches-with-no-results: {
    get: (
        __namedParameters: {
            endDate?: string;
            includeReplicas?: boolean;
            limit?: number;
            offset?: number;
            startDate?: string;
            tags?: string;
        },
    ) => Promise<SearchIndexSearchesWithNoResultsCollection>;
}
settings: {
    get: () => Promise<SearchIndexSettings>;
    update: (
        resource: SearchIndexSettings,
        forwardToReplicas?: boolean,
        options?: { waitUntilApplied: boolean | string[] },
    ) => Promise<SearchIndexSettings>;
}
stats: { get: (period?: string) => Promise<SearchIndexStatistics> }
top-filters-no-result-search: {
    get: (
        __namedParameters: {
            endDate?: string;
            includeReplicas?: boolean;
            limit?: number;
            offset?: number;
            search: string;
            startDate?: string;
            tags?: string;
        },
    ) => Promise<SearchIndexTopFiltersNoResultSearchCollection>;
}
top-hits: {
    get: (
        __namedParameters: {
            endDate?: string;
            includeReplicas?: boolean;
            limit?: number;
            offset?: number;
            search?: string;
            startDate?: string;
            tags?: string;
        },
    ) => Promise<SearchIndexTopHitsCollection>;
}
top-searches: {
    get: (
        __namedParameters: {
            clickAnalytics?: boolean;
            direction?: "asc" | "desc";
            endDate?: string;
            includeReplicas?: boolean;
            limit?: number;
            offset?: number;
            orderBy?: SearchesOrderBy;
            startDate?: string;
            tags?: string;
        },
    ) => Promise<SearchIndexTopSearchesCollection>;
}
update: (resource: SearchIndex) => Promise<SearchIndex>
users-count: {
    get: (
        __namedParameters: {
            endDate?: string;
            includeReplicas?: boolean;
            startDate?: string;
            tags?: string;
        },
    ) => Promise<SearchIndexUsersCount>;
}

`Optional`replicaCount

replicaCount?: number

Number of replica indexes for this index (only present on non-replica indexes).

`Optional`suffix

suffix?: string

User defined suffix used to uniquely name the index.

`Optional`type

type?: string

Type of index.

Methods

`Protected`performActionWithoutResourceResponse

performActionWithoutResourceResponse(
    name: string,
    params: any,
    data: any,
    method?: POST | PUT | PATCH,
): Promise<void>
POST to an action endpoint with no resource response returned.
Parameters
- name: string
- params: any
- data: any
- method: POST | PUT | PATCH = HttpMethod.POST
Returns Promise<void>
Inherited from HalResource.performActionWithoutResourceResponse
- Defined in src/lib/hal/models/HalResource.ts:154

toJson

toJson(): any
Returns a copy of this resource's attributes excluding links and client references

Returns any
Deprecated
Inherited from HalResource.toJson
- Defined in src/lib/hal/models/HalResource.ts:64

toJSON

toJSON(): any
Returns a copy of this resource's attributes excluding links and client references

Returns any
Inherited from HalResource.toJSON
- Defined in src/lib/hal/models/HalResource.ts:52

Class SearchIndex

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SearchIndex

Properties

Optional_links

OptionalcreatedDate

Optionalid

Optionallabel

OptionallastModifiedDate

Optionalname

OptionalparentId

Readonlyrelated

Type declaration

assignedContentTypes: { create: (resource: AssignedContentType) => Promise<AssignedContentType>; get: (id: string) => Promise<AssignedContentType>; list: (options?: Pageable & Sortable) => Promise<Page<AssignedContentType>>;}

clear: () => Promise<SearchIndex>

delete: () => Promise<void>

hub: () => Promise<Hub>

indexObject: { delete: (id: string) => Promise<void> }

keys: { get: () => Promise<SearchIndexKey> }

no-results-rate: { get: ( __namedParameters: { endDate?: string; includeReplicas?: boolean; startDate?: string; tags?: string; }, ) => Promise<SearchIndexNoResultsRate>;}

replicas: { list: ( projection?: string, options?: Pageable & Sortable, ) => Promise<Page<SearchIndex>>;}

searches-count: { get: ( __namedParameters: { endDate?: string; includeReplicas?: boolean; startDate?: string; tags?: string; }, ) => Promise<SearchIndexSearchesCount>;}

searches-with-no-results: { get: ( __namedParameters: { endDate?: string; includeReplicas?: boolean; limit?: number; offset?: number; startDate?: string; tags?: string; }, ) => Promise<SearchIndexSearchesWithNoResultsCollection>;}

settings: { get: () => Promise<SearchIndexSettings>; update: ( resource: SearchIndexSettings, forwardToReplicas?: boolean, options?: { waitUntilApplied: boolean | string[] }, ) => Promise<SearchIndexSettings>;}

stats: { get: (period?: string) => Promise<SearchIndexStatistics> }

top-filters-no-result-search: { get: ( __namedParameters: { endDate?: string; includeReplicas?: boolean; limit?: number; offset?: number; search: string; startDate?: string; tags?: string; }, ) => Promise<SearchIndexTopFiltersNoResultSearchCollection>;}

top-hits: { get: ( __namedParameters: { endDate?: string; includeReplicas?: boolean; limit?: number; offset?: number; search?: string; startDate?: string; tags?: string; }, ) => Promise<SearchIndexTopHitsCollection>;}

top-searches: { get: ( __namedParameters: { clickAnalytics?: boolean; direction?: "asc" | "desc"; endDate?: string; includeReplicas?: boolean; limit?: number; offset?: number; orderBy?: SearchesOrderBy; startDate?: string; tags?: string; }, ) => Promise<SearchIndexTopSearchesCollection>;}

update: (resource: SearchIndex) => Promise<SearchIndex>

users-count: { get: ( __namedParameters: { endDate?: string; includeReplicas?: boolean; startDate?: string; tags?: string; }, ) => Promise<SearchIndexUsersCount>;}

OptionalreplicaCount

Optionalsuffix

Optionaltype

Methods

ProtectedperformActionWithoutResourceResponse

Parameters

Returns Promise<void>

toJson

Returns any

Deprecated

toJSON

Returns any

Settings

On This Page

`Optional`_links

`Optional`createdDate

`Optional`id

`Optional`label

`Optional`lastModifiedDate

`Optional`name

`Optional`parentId

`Readonly`related

assignedContentTypes: {
create: (resource: AssignedContentType) => Promise<AssignedContentType>;
get: (id: string) => Promise<AssignedContentType>;
list: (options?: Pageable & Sortable) => Promise<Page<AssignedContentType>>;
}

no-results-rate: {
get: (
__namedParameters: {
endDate?: string;
includeReplicas?: boolean;
startDate?: string;
tags?: string;
},
) => Promise<SearchIndexNoResultsRate>;
}

replicas: {
list: (
projection?: string,
options?: Pageable & Sortable,
) => Promise<Page<SearchIndex>>;
}

searches-count: {
get: (
__namedParameters: {
endDate?: string;
includeReplicas?: boolean;
startDate?: string;
tags?: string;
},
) => Promise<SearchIndexSearchesCount>;
}

searches-with-no-results: {
get: (
__namedParameters: {
endDate?: string;
includeReplicas?: boolean;
limit?: number;
offset?: number;
startDate?: string;
tags?: string;
},
) => Promise<SearchIndexSearchesWithNoResultsCollection>;
}

settings: {
get: () => Promise<SearchIndexSettings>;
update: (
resource: SearchIndexSettings,
forwardToReplicas?: boolean,
options?: { waitUntilApplied: boolean | string[] },
) => Promise<SearchIndexSettings>;
}

top-filters-no-result-search: {
get: (
__namedParameters: {
endDate?: string;
includeReplicas?: boolean;
limit?: number;
offset?: number;
search: string;
startDate?: string;
tags?: string;
},
) => Promise<SearchIndexTopFiltersNoResultSearchCollection>;
}

top-hits: {
get: (
__namedParameters: {
endDate?: string;
includeReplicas?: boolean;
limit?: number;
offset?: number;
search?: string;
startDate?: string;
tags?: string;
},
) => Promise<SearchIndexTopHitsCollection>;
}

top-searches: {
get: (
__namedParameters: {
clickAnalytics?: boolean;
direction?: "asc" | "desc";
endDate?: string;
includeReplicas?: boolean;
limit?: number;
offset?: number;
orderBy?: SearchesOrderBy;
startDate?: string;
tags?: string;
},
) => Promise<SearchIndexTopSearchesCollection>;
}

users-count: {
get: (
__namedParameters: {
endDate?: string;
includeReplicas?: boolean;
startDate?: string;
tags?: string;
},
) => Promise<SearchIndexUsersCount>;
}

`Optional`replicaCount

`Optional`suffix

`Optional`type

`Protected`performActionWithoutResourceResponse