StatisticsRequest | @here/olp-sdk-ts
Class StatisticsRequest
Hierarchy
- StatisticsRequest
Index
Constructors
constructor
Returns StatisticsRequest
Methods
get
Gets a billing tag to group billing records together.
Returns undefined | string
The
BillingTagstring.
get
get
Gets a tile level for the request.
Returns undefined | number
The requested tile level number.
get
Gets a layer ID for the request.
Returns undefined | string
The layer ID string.
get
with
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].
Parameters
tag: string
The
BillingTagstring.
Returns StatisticsRequest
The updated StatisticsRequest instance that you can use to chain methods.
with
A setter for the provided catalog HERE Resource Name (HRN).
Parameters
hrn: HRN
The catalog HRN.
Returns StatisticsRequest
The updated StatisticsRequest instance that you can use to chain methods.
with
A setter for the provided
dataLevel.Parameters
dataLevel: number
By default, assets generated at deepest data level are returned. Note that assets returned for data levels greater than 11 represent data at data level 11.
Returns StatisticsRequest
The updated StatisticsRequest instance that you can use to chain methods.
with
A setter for the requested
layerIdstring.Parameters
layerId: string
The ID of the layer.
Returns StatisticsRequest
The updated StatisticsRequest instance that you can use to chain methods.
with
A setter for the provided
coverageDataTypestring.Parameters
coverageDataType: CoverageDataType
Points at one of the following Statistic API endpoints:
- BITMAP – fetches a bitmap that represents the availability of data in partitions.
- SIZEMAP – fetches a heatmap that represents a partition size.
- TIMEMAP – fetches a heatmap that represents partition update time.
Returns StatisticsRequest
The updated StatisticsRequest instance that you can use to chain methods.
Generated using TypeDoc
Prepares information for calls to get statistics from the platform Statistics Service.