StatisticsClient
Constructors
constructor
- new
Statistics Client(settings: OlpClientSettings): StatisticsClient
-
Creates the StatisticsClient instance.
Parameters-
settings: OlpClientSettings
The OlpClientSettings instance.
Returns StatisticsClientThe StatisticsClient instance.
-
Methods
get
- get
Statistics(statisticsRequest: StatisticsRequest): Promise<Response>
-
Depending on the map type that you specify in the StatisticsRequest instance, gets the StatisticsRequest instance with one of the following settings:
- 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.
Parameters-
statisticsRequest: StatisticsRequest
The StatisticsRequest instance with the requested settings.
Returns Promise<Response>The [StatisticsRequest]] instance with the requested settings.
get
- get
Summary(summaryRequest: SummaryRequest): Promise<CoverageApi.LayerSummary>
-
Fetches and returns a layer summary from the platform Statistics Service.
Parameters-
summaryRequest: SummaryRequest
Parameters that are needed to fetch the layer summary. Includes catalogHrn and layerId.
A promise with the layer summary.
-
A client for the platform Statistics Service.