SearchIndex | dc-management-sdk-js

Class representing an Algolia Search Index.

Hierarchy

HalResource
- SearchIndex

Index

Constructors

constructor

Properties

Methods

Object literals

Constructors

constructor

new SearchIndex(data?: any): SearchIndex

Inherited from HalResource.constructor
- Defined in src/lib/hal/models/HalResource.ts:28
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
- Optional data: any
Returns SearchIndex

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).

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 | PATCH | PUT): Promise<void>

Inherited from HalResource.performActionWithoutResourceResponse
- Defined in src/lib/hal/models/HalResource.ts:155
POST to an action endpoint with no resource response returned.

Parameters
- name: string
- params: any
- data: any
- Default value method: POST | PATCH | PUT = HttpMethod.POST
Returns Promise<void>

toJSON

toJSON(): any

Inherited from HalResource.toJSON
- Defined in src/lib/hal/models/HalResource.ts:53
Returns a copy of this resource's attributes excluding links and client references

Returns any

toJson

toJson(): any

Inherited from HalResource.toJson
- Defined in src/lib/hal/models/HalResource.ts:65
Returns a copy of this resource's attributes excluding links and client references

deprecated

Returns any

Object literals

Readonly related

related: object

Resources and actions related to a Search Index.

clear

clear(): Promise<SearchIndex>

- Defined in src/lib/model/SearchIndex.ts:88
Returns Promise<SearchIndex>

delete

delete(): Promise<void>

- Defined in src/lib/model/SearchIndex.ts:91
Returns Promise<void>

hub

hub(): Promise<Hub>

- Defined in src/lib/model/SearchIndex.ts:86
Retrieves the Hub this search index is stored in

Returns Promise<Hub>

update

update(resource: SearchIndex): Promise<SearchIndex>

- Defined in src/lib/model/SearchIndex.ts:93
Parameters
- resource: SearchIndex
Returns Promise<SearchIndex>

assignedContentTypes

assignedContentTypes: object

create

create(resource: AssignedContentType): Promise<AssignedContentType>

- Defined in src/lib/model/SearchIndex.ts:97
Parameters
- resource: AssignedContentType
Returns Promise<AssignedContentType>

get

get(id: string): Promise<AssignedContentType>

- Defined in src/lib/model/SearchIndex.ts:105
Parameters
- id: string
Returns Promise<AssignedContentType>

list

list(options?: Pageable & Sortable): Promise<Page<AssignedContentType>>

- Defined in src/lib/model/SearchIndex.ts:112
Parameters
- Optional options: Pageable & Sortable
Returns Promise<Page<AssignedContentType>>

indexObject

indexObject: object

delete

delete(id: string): Promise<void>

- Defined in src/lib/model/SearchIndex.ts:123
Parameters
- id: string
Returns Promise<void>

keys

keys: object

get

get(): Promise<SearchIndexKey>

- Defined in src/lib/model/SearchIndex.ts:129
Returns Promise<SearchIndexKey>

no-results-rate

no-results-rate: object

get

get(__namedParameters: { endDate: string; includeReplicas: boolean; startDate: string; tags: string }): Promise<SearchIndexNoResultsRate>

- Defined in src/lib/model/SearchIndex.ts:385
Parameters
- __namedParameters: { endDate: string; includeReplicas: boolean; startDate: string; tags: string }
  - endDate: string
  - includeReplicas: boolean
  - startDate: string
  - tags: string
Returns Promise<SearchIndexNoResultsRate>

replicas

replicas: object

list

list(projection?: string, options?: Pageable & Sortable): Promise<Page<SearchIndex>>

- Defined in src/lib/model/SearchIndex.ts:134
Parameters
- Optional projection: string
- Optional options: Pageable & Sortable
Returns Promise<Page<SearchIndex>>

searches-count

searches-count: object

get

get(__namedParameters: { endDate: string; includeReplicas: boolean; startDate: string; tags: string }): Promise<SearchIndexSearchesCount>

- Defined in src/lib/model/SearchIndex.ts:362
Parameters
- __namedParameters: { endDate: string; includeReplicas: boolean; startDate: string; tags: string }
  - endDate: string
  - includeReplicas: boolean
  - startDate: string
  - tags: string
Returns Promise<SearchIndexSearchesCount>

searches-with-no-results

searches-with-no-results: object

get

get(__namedParameters: { endDate: string; includeReplicas: boolean; limit: number; offset: number; startDate: string; tags: string }): Promise<SearchIndexSearchesWithNoResultsCollection>

- Defined in src/lib/model/SearchIndex.ts:278
Parameters
- __namedParameters: { endDate: string; includeReplicas: boolean; limit: number; offset: number; startDate: string; tags: string }
  - endDate: string
  - includeReplicas: boolean
  - limit: number
  - offset: number
  - startDate: string
  - tags: string
Returns Promise<SearchIndexSearchesWithNoResultsCollection>

settings

settings: object

get

get(): Promise<SearchIndexSettings>

- Defined in src/lib/model/SearchIndex.ts:146
Returns Promise<SearchIndexSettings>

update

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

- Defined in src/lib/model/SearchIndex.ts:152
Parameters
- resource: SearchIndexSettings
- Optional forwardToReplicas: boolean
- Optional options: { waitUntilApplied: boolean | string[] }
  - waitUntilApplied: boolean | string[]
Returns Promise<SearchIndexSettings>

stats

stats: object

get

get(period?: string): Promise<SearchIndexStatistics>

- Defined in src/lib/model/SearchIndex.ts:201
Parameters
- Optional period: string
Returns Promise<SearchIndexStatistics>

top-filters-no-result-search

top-filters-no-result-search: object

get

get(__namedParameters: { endDate: string; includeReplicas: boolean; limit: number; offset: number; search: string; startDate: string; tags: string }): Promise<SearchIndexTopFiltersNoResultSearchCollection>

- Defined in src/lib/model/SearchIndex.ts:307
Parameters
- __namedParameters: { endDate: string; includeReplicas: boolean; limit: number; offset: number; search: string; startDate: string; tags: string }
  - endDate: string
  - includeReplicas: boolean
  - limit: number
  - offset: number
  - search: string
  - startDate: string
  - tags: string
Returns Promise<SearchIndexTopFiltersNoResultSearchCollection>

top-hits

top-hits: object

get

get(__namedParameters: { endDate: string; includeReplicas: boolean; limit: number; offset: number; search: string; startDate: string; tags: string }): Promise<SearchIndexTopHitsCollection>

- Defined in src/lib/model/SearchIndex.ts:245
Parameters
- __namedParameters: { endDate: string; includeReplicas: boolean; limit: number; offset: number; search: string; startDate: string; tags: string }
  - endDate: string
  - includeReplicas: boolean
  - limit: number
  - offset: number
  - search: string
  - startDate: string
  - tags: string
Returns Promise<SearchIndexTopHitsCollection>

top-searches

top-searches: object

get

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

- Defined in src/lib/model/SearchIndex.ts:206
Parameters
- __namedParameters: { clickAnalytics: boolean; direction: "asc" | "desc"; endDate: string; includeReplicas: boolean; limit: number; offset: number; orderBy: SearchesOrderBy; startDate: string; tags: string }
  - clickAnalytics: boolean
  - direction: "asc" | "desc"
  - endDate: string
  - includeReplicas: boolean
  - limit: number
  - offset: number
  - orderBy: SearchesOrderBy
  - startDate: string
  - tags: string
Returns Promise<SearchIndexTopSearchesCollection>

users-count

users-count: object

get

get(__namedParameters: { endDate: string; includeReplicas: boolean; startDate: string; tags: string }): Promise<SearchIndexUsersCount>

- Defined in src/lib/model/SearchIndex.ts:339
Parameters
- __namedParameters: { endDate: string; includeReplicas: boolean; startDate: string; tags: string }
  - endDate: string
  - includeReplicas: boolean
  - startDate: string
  - tags: string
Returns Promise<SearchIndexUsersCount>

Hierarchy

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

Optional data: any

Returns SearchIndex

Properties

Optional _links

Optional createdDate

Optional id

Optional label

Optional lastModifiedDate

Optional name

Optional parentId

Optional replicaCount

Optional suffix

Optional type

Methods

Protected performActionWithoutResourceResponse

Parameters

name: string

params: any

data: any

Default value method: POST | PATCH | PUT = HttpMethod.POST

Returns Promise<void>

toJSON

Returns any

toJson

Returns any

Object literals

Readonly related

clear

Returns Promise<SearchIndex>

delete

Returns Promise<void>

hub

Returns Promise<Hub>

update

Parameters

resource: SearchIndex

Returns Promise<SearchIndex>

assignedContentTypes

create

Parameters

resource: AssignedContentType

Returns Promise<AssignedContentType>

get

Parameters

id: string

Returns Promise<AssignedContentType>

list

Parameters

Optional options: Pageable & Sortable

Returns Promise<Page<AssignedContentType>>

indexObject

delete

Parameters

id: string

Returns Promise<void>

keys

get

Returns Promise<SearchIndexKey>

no-results-rate

get

Parameters

__namedParameters: { endDate: string; includeReplicas: boolean; startDate: string; tags: string }

endDate: string

includeReplicas: boolean

startDate: string

tags: string

Returns Promise<SearchIndexNoResultsRate>

replicas

list

Parameters

Optional projection: string