QueryClient
Constructors
constructor
- new
Query Client(settings: OlpClientSettings): QueryClient
-
Constructs a new client for the Query Service API.
Parameters-
settings: OlpClientSettings
The OlpClientSettings instance.
Returns QueryClientThe QueryClient instance.
-
Methods
fetch
- fetch
Quad Tree Index(request: QuadTreeIndexRequest, abortSignal?: AbortSignal): Promise<QueryApi.Index>
-
Fetches the quadtree index.
Parameters-
request: QuadTreeIndexRequest
The configured QuadTreeIndexRequest instance.
-
Optional abortSignal: AbortSignal
A signal object that allows you to communicate with a request (such as the
fetchrequest) and, if required, abort it using theAbortControllerobject.For more information, see the
AbortControllerdocumentation.
The quadtree index object.
-
get
- get
Partitions By Id(request: PartitionsRequest, layerId: string, hrn: HRN, abortSignal?: AbortSignal, catalogVersion?: number): Promise<QueryApi.Partitions>
-
Gets partitions using their IDs.
Parameters-
request: PartitionsRequest
The
PartitionsRequestinstance. -
layerId: string
The ID of the layer from which you want to get partitions.
-
hrn: HRN
The HERE Resource Name (HRN) of the layer.
-
Optional abortSignal: AbortSignal
A signal object that allows you to communicate with a request (such as the
fetchrequest) and, if required, abort it using theAbortControllerobject.For more information, see the
AbortControllerdocumentation. -
Optional catalogVersion: number
The requested partitions.
-
A client for the Query Service API that provides a way to get information (metadata) about layers and partitions stored in a catalog. This service exposes the metadata for a single partition that you can query one by one or using a parent tile.