import { HRN, QuadKey } from "@here/olp-sdk-core";
import { AdditionalFields } from "@here/olp-sdk-dataservice-api";
/**
 * The recursion depth of the quadtree.
 *
 * If set to 0, the response includes only data for the quadKey specified in the request.
 * In this way, depth describes the maximum length of the subQuadKeys in the response.
 * The maximum allowed value for the depth parameter is 4.
 */
export declare type QuadTreeIndexDepth = 0 | 1 | 2 | 3 | 4;
/**
 * 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.
 */
export declare class QuadTreeIndexRequest {
    private catalogHrn;
    private layerId;
    private layerType;
    private version?;
    private quadKey?;
    private depth?;
    private billingTag?;
    private additionalFields?;
    /**
     * Constructs the [[QuadTreeIndexRequest]] instance for fetching the quadtree index from the Query Service API
     * for volatile or versioned layers
     *
     * @param catalogHrn The catalog HERE Resource Name ([[HRN]]).
     * @param layerId The ID of the layer.
     * @param layerType The type of layer that you want to use for the request. By default, a layer of the versioned type is used.
     * @return The [[QuadTreeIndexRequest]] instance
     */
    constructor(catalogHrn: HRN, layerId: string, layerType?: "versioned" | "volatile");
    /**
     * The version of the catalog against which you want to run the query.
     * It must be a valid catalog version.
     *
     * @param version Specify the catalog version or, if you want to use the latest catalog version, set to undefined.
     * @returns The updated [[QuadKeyPartitionsRequest]] instance that you can use to chain methods.
     */
    withVersion(version?: number): QuadTreeIndexRequest;
    /**
     * A geometric area represented as a HERE tile.
     *
     * @param quadKey Addresses a tile in the quadtree.
     * @returns The updated [[QuadKeyPartitionsRequest]] instance that you can use to chain methods.
     */
    withQuadKey(quadKey: QuadKey): QuadTreeIndexRequest;
    /**
     * The recursion depth of the response.
     * The maximum allowed value for the depth parameter is 4.
     *
     * @param depth The recursion depth of the response.
     * @returns The 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.
     */
    withDepth(depth: QuadTreeIndexDepth): 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].
     *
     * @param tag The `BillingTag` string.
     * @return The updated [[QuadTreeIndexRequest]] instance that you can use to chain methods.
     */
    withBillingTag(tag: string): QuadTreeIndexRequest;
    /**
     * A setter for the provided additional fields.
     *
     * @param 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 The updated [[QuadTreeIndexRequest]] instance that you can use to chain methods.
     */
    withAdditionalFields(additionalFields?: AdditionalFields): QuadTreeIndexRequest;
    /**
     * The configured catalog version for the request.
     *
     * @return The catalog version number.
     */
    getVersion(): number | undefined;
    /**
     * Gets the configured [[QuadKey]] object for the request.
     *
     * @return The the configured [[QuadKey]] object.
     */
    getQuadKey(): QuadKey | undefined;
    /**
     * Gets the configured depth for the request.
     *
     * @return The number of the configured depth.
     */
    getDepth(): number;
    /**
     * Gets the configured type of the layer for the request.
     * By default, a layer of the versioned type is used.
     *
     * @return The layer type.
     */
    getLayerType(): "versioned" | "volatile";
    /**
     * Gets the configured [[HRN]] instance of the catalog HERE Resource Name(HRN) for the request.
     *
     * @return The configured [[HRN]] instance.
     */
    getCatalogHrn(): HRN;
    /**
     * Gets a layer ID for the request.
     *
     * @return The layer ID string.
     */
    getLayerId(): string | undefined;
    /**
     * Gets a billing tag to group billing records together.
     *
     * @return The `BillingTag` string.
     */
    getBillingTag(): string | undefined;
    /**
     * Gets the additional fields for the request.
     *
     * @return Additional fields.
     */
    getAdditionalFields(): AdditionalFields | undefined;
}