Class SearchIndexStatistics

Class representing Statistics for an Algolia Search Index

Hierarchy (View Summary)

HalResource
- SearchIndexStatistics

Index

Constructors

Properties

_links? averageRecordSize? totalRecords? totalRecordSize? usage?

Methods

performActionWithoutResourceResponse toJson toJSON

Constructors

constructor

new SearchIndexStatistics(data?: any): SearchIndexStatistics
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 SearchIndexStatistics
Inherited from HalResource.constructor
- Defined in src/lib/hal/models/HalResource.ts:35

Properties

`Optional`_links

_links?: Map<string, HalLink>

`Optional`averageRecordSize

averageRecordSize?: number

Average size of an index record (in bytes).

`Optional`totalRecords

totalRecords?: number

Total number of records within an index.

`Optional`totalRecordSize

totalRecordSize?: number

Total size of records (in bytes).

`Optional`usage

usage?: SearchIndexStatisticsUsage

Usage statistics for an 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:179

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