import { FetchOptions } from "@here/olp-sdk-core"; import { AdditionalFields } from "@here/olp-sdk-dataservice-api"; /** * Prepares information for calls to get partitions metadata from the Metadata Service API. */ export declare class PartitionsRequest { private version?; private billingTag?; private partitionIds?; private additionalFields?; private fetchOption; /** * 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 [[PartitionsRequest]] instance that you can use to chain methods. */ withBillingTag(tag: string): PartitionsRequest; /** * Gets a billing tag to group billing records together. * * @return The `BillingTag` string. */ getBillingTag(): string | undefined; /** * Sets the provided partition IDs. * * @param ids The IDs of partitions from which you want to get metadata. * * The required quantity is between 1 and 100. * If partition IDs are not provided, all partitions are retrieved. * If the quantity of partition IDs is less than 1 (empty array) or more than 100, an error is thrown. * @returns The updated [[PartitionsRequest]] instance that you can use to chain methods. */ withPartitionIds(ids: string[]): PartitionsRequest; /** * Gets partition IDs for the request. * * @return The `partitionIds` string. */ getPartitionIds(): string[] | undefined; /** * Sets the provided additional fields: `dataSize`, `checksum`, `compressedDataSize`, and `crc`. * * @param additionalFields The array of strings. * The array can contain the following values: `dataSize`, `checksum`, `compressedDataSize`, and `crc`. * * @returns The updated [[PartitionsRequest]] instance that you can use to chain methods. */ withAdditionalFields(additionalFields: AdditionalFields): PartitionsRequest; /** * Gets additional fields for the request. * * @return The `partitionIds` string. */ getAdditionalFields(): AdditionalFields | undefined; /** * Sets the fetch option that you can use to set the source from * which data should be fetched. * * @see `getFetchOption()` for information on usage and format. * * @param option The `FetchOption` enum. * * @return A reference to the updated `PartitionsRequest` instance. */ withFetchOption(option: FetchOptions): PartitionsRequest; /** * Gets the fetch option that controls how requests are handled. * * The default option is `OnlineIfNotFound`. It queries the network if * the requested resource is not in the cache. * * @return The fetch option. */ getFetchOption(): FetchOptions; }