import { HRN, OlpClientSettings } from "@here/olp-sdk-core"; import { MetadataApi, QueryApi } from "@here/olp-sdk-dataservice-api"; import { DataRequest, PartitionsRequest, QuadKeyPartitionsRequest, TileRequest } from "@here/olp-sdk-dataservice-read"; /** * Parameters for use to initialize VolatileLayerClient. */ export interface VolatileLayerClientParams { /** The HRN of the catalog. */ catalogHrn: HRN; /** The ID of the layer. */ layerId: string; /** The [[OlpClientSettings]] instance. */ settings: OlpClientSettings; } /** * Describes a voaltile layer and provides the possibility to get partitions metadata and data. */ export declare class VolatileLayerClient { private readonly apiVersion; /** * HRN of the catalog. */ private hrn; /** * The ID of the layer. */ private layerId; /** * The [[OlpClientSettings]] instance. */ private settings; /** * Creates the [[VolatileLayerClient]] instance with VolatileLayerClientParams. * * @param params parameters for use to initialize VolatileLayerClient. */ constructor(params: VolatileLayerClientParams); /** * @brief Fetches data of a tile or its closest ancestor. * Use this API for tile-tree structures where children tile data is aggregated and stored in parent tiles. * * @param request The `TileRequest` instance that contains a complete set * of request parameters. * @param abortSignal A signal object that allows you to communicate with a request (such as the `fetch` request) * and, if required, abort it using the `AbortController` object. * * For more information, see the [`AbortController` documentation](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). * * @return Tile data (if it exists) or the nearest parent tile data */ getAggregatedData(request: TileRequest, abortSignal?: AbortSignal): Promise; /** * Fetches partition data using one of the following methods: ID, quadkey, or data handle. * * @param dataRequest The [[DataRequest]] instance of the configured request parameters. * @param abortSignal A signal object that allows you to communicate with a request (such as the `fetch` request) * and, if required, abort it using the `AbortController` object. * * For more information, see the [`AbortController` documentation](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). * * @return The data from the requested partition. */ getData(dataRequest: DataRequest, abortSignal?: AbortSignal): Promise; /** * Fetches partitions metadata from the Query Service API using a quadkey. * * @param quadKeyPartitionsRequest The [[QuadKeyPartitionsRequest]] instance. * @param abortSignal A signal object that allows you to communicate with a request (such as the `fetch` request) * and, if required, abort it using the `AbortController` object. * * For more information, see the [`AbortController` documentation](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). * * @returns The quadtree index for the requested partitions. */ getPartitions(quadKeyPartitionsRequest: QuadKeyPartitionsRequest, abortSignal?: AbortSignal): Promise; /** * Fetches all partitions metadata from a layer using the partition ID from the [[PartitionsRequest]] instance. * * @param partitionsRequest The [[PartitionsRequest]] instance. * @param abortSignal A signal object that allows you to communicate with a request (such as the `fetch` request) * and, if required, abort it using the `AbortController` object. * * For more information, see the [`AbortController` documentation](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). * * @returns A list of metadata for each of the partitions from the requested layer. * If the partition IDs are not set, you get metadata from all of the partitions of the requested layer * from the Metadata Service API. * If the IDs are set, you get data from the Query Service API. */ getPartitions(partitionsRequest: PartitionsRequest, abortSignal?: AbortSignal): Promise; private downloadPartition; /** * Fetches baseUrl and creates requestBuilder for sending requests to the API Lookup Service. * @param builderType endpoint name is needed to create propriate requestBuilder * * @returns requestBuilder */ private getRequestBuilder; /** * Fetch and returns partition metadata * @param partitionId The name of the partition to fetch. * @param fetchOption The option of caching (online only or return from cache if exist) * @returns A promise of partition metadata which used to get partition data */ private getDataHandleByPartitionId; }