Jump to Content

IndexLayerClient | @here/olp-sdk-ts

IndexLayerClient | @here/olp-sdk-ts

Class IndexLayerClient

Describes a index layer and provides the possibility to get partitions metadata and data.

Hierarchy

IndexLayerClient

Index

Constructors

constructor

Methods

Constructors

constructor

new IndexLayerClient(params: IndexLayerClientParams): IndexLayerClient

- Defined in @here/olp-sdk-dataservice-read/lib/client/IndexLayerClient.ts:68
Creates the IndexLayerClient instance with IndexLayerClientParams.

Parameters
- params: IndexLayerClientParams
  
  parameters for use to initialize IndexLayerClient.
Returns IndexLayerClient

Methods

getData

getData(model: IndexApi.Index, abortSignal?: AbortSignal): Promise<Response>

- Defined in @here/olp-sdk-dataservice-read/lib/client/IndexLayerClient.ts:122
Fetches partition data using data handle.

Parameters
- model: IndexApi.Index
  
  The data model of partition metadata.
- Optional abortSignal: AbortSignal
  
  A signal object that allows you to communicate with a request (such as the fetch request) and, if required, abort it using the AbortController object.
  
  For more information, see the AbortController documentation.
Returns Promise<Response>
The data from the requested partition.

getPartitions

getPartitions(request: IndexQueryRequest, abortSignal?: AbortSignal): Promise<IndexApi.Index[]>

- Defined in @here/olp-sdk-dataservice-read/lib/client/IndexLayerClient.ts:85
Fetches all partitions metadata from a layer that match a query from the IndexQueryRequest instance.

Parameters
- request: IndexQueryRequest
- Optional abortSignal: AbortSignal
  
  A signal object that allows you to communicate with a request (such as the fetch request) and, if required, abort it using the AbortController object.
  
  For more information, see the AbortController documentation.
Returns Promise<IndexApi.Index[]>
A list of metadata for each of the partitions from the requested layer.

Generated using TypeDoc