IndexQueryRequest | @here/olp-sdk-ts
Class IndexQueryRequest
Hierarchy
- IndexQueryRequest
Index
Constructors
Methods
Constructors
constructor
Returns IndexQueryRequest
Methods
get
Gets isHugeResponse property for the request.
Returns undefined | boolean
The
isHugeResponseboolean.
get
Gets a queryString for the request.
Returns undefined | string
The queryString string.
with
A setter for the provided isHugeResponse parameter.
Parameters
isHuge: boolean
The boolean parameter shows is the query huge.
Returns IndexQueryRequest
The updated IndexQueryRequest instance that you can use to chain methods.
with
Parameters
Optional query: string
An RSQL query to use to retrieve partitions that match the query. The query must use the indexing attributes defined in the index layer.
Returns IndexQueryRequest
The updated IndexQueryRequest instance that you can use to chain methods.
Generated using TypeDoc
Prepares information for calls to get partitions metadata from the platform Index Service.