QuadTreeIndexRequest
Constructors
constructor
- new
Quad Tree Index Request(catalogHrn: HRN, layerId: string, layerType?: "versioned" | "volatile"): QuadTreeIndexRequest
-
Constructs the QuadTreeIndexRequest instance for fetching the quadtree index from the Query Service API for volatile or versioned layers
Parameters-
catalogHrn: HRN
The catalog HERE Resource Name (HRN).
-
layerId: string
The ID of the layer.
-
layerType: "versioned" | "volatile" = "versioned"
The type of layer that you want to use for the request. By default, a layer of the versioned type is used.
Returns QuadTreeIndexRequestThe QuadTreeIndexRequest instance
-
Methods
with
- with
Additional Fields(additionalFields?: AdditionalFields): QuadTreeIndexRequest
-
A setter for the provided additional fields.
Parameters-
Optional additionalFields: AdditionalFields
Array of strings. Array could contain next values "dataSize" | "checksum" | "compressedDataSize | "crc"". This values could be useful for getPartitions method from versionedLayerClient and volatileLayerClient.
Returns QuadTreeIndexRequestThe updated QuadTreeIndexRequest instance that you can use to chain methods.
-
with
- with
Billing Tag(tag: string): QuadTreeIndexRequest
-
An optional free-form tag that is used for grouping billing records together.
If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A-Za-z0-9].
ParametersReturns QuadTreeIndexRequestThe updated QuadTreeIndexRequest instance that you can use to chain methods.
with
- with
Depth(depth: QuadTreeIndexDepth): QuadTreeIndexRequest
-
The recursion depth of the response. The maximum allowed value for the depth parameter is 4.
Parameters-
depth: QuadTreeIndexDepth
The recursion depth of the response.
Returns QuadTreeIndexRequestThe updated QuadKeyPartitionsRequest instance that you can use to chain methods.
If set to 0, the response includes only data from the quadkey specified in the request. In this way, the depth describes the maximum length of the subQuadKeys in the response.
-
with
- with
Quad Key(quadKey: QuadKey): QuadTreeIndexRequest
-
A geometric area represented as a HERE tile.
Parameters-
quadKey: QuadKey
Addresses a tile in the quadtree.
Returns QuadTreeIndexRequestThe updated QuadKeyPartitionsRequest instance that you can use to chain methods.
-
with
- with
Version(version?: number): QuadTreeIndexRequest
-
The version of the catalog against which you want to run the query. It must be a valid catalog version.
Parameters-
Optional version: number
Specify the catalog version or, if you want to use the latest catalog version, set to undefined.
Returns QuadTreeIndexRequestThe updated QuadKeyPartitionsRequest instance that you can use to chain methods.
-
Prepares information for calls to get quadtree metadata from the Query Service API.
This class works only with versioned or volatile layers where the partitioning scheme is HERE Tile.