Namespace IndexApi

Index

Interfaces

Functions

Functions

insertIndexes

insertIndexes(builder: RequestBuilder, params: { indexes: IndexApi.Index[]; layerID: string }): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/index-api.ts:91
Adds index data for a given data blob to an index layer. For more information, see Publish to an Index Layer.

summary
Inserts index data to an index layer

Parameters
- builder: RequestBuilder
- params: { indexes: IndexApi.Index[]; layerID: string }
  - indexes: IndexApi.Index[]
  - layerID: string
Returns Promise<Response>

performQuery

performQuery(builder: RequestBuilder, params: { huge?: boolean; layerID: string; query: string }): Promise<DataResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/index-api.ts:131
Queries the index layer for the partitions that match the query. Returns each partition that matches the query, including each partition's data handle, which you use with the blob API to retrieve data for each partition.

summary
Gets the partitions that match the query

Parameters
- builder: RequestBuilder
- params: { huge?: boolean; layerID: string; query: string }
  - Optional huge?: boolean
  - layerID: string
  - query: string
Returns Promise<DataResponse>

performUpdate

performUpdate(builder: RequestBuilder, params: { layerID: string; request: UpdateIndexRequest }): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/index-api.ts:164
Modifies partitions in an index layer.

summary
Updates index layer partitions

Parameters
- builder: RequestBuilder
- params: { layerID: string; request: UpdateIndexRequest }
  - layerID: string
  - request: UpdateIndexRequest
Returns Promise<Response>

Generated using TypeDoc