PartitionsRequest | @here/olp-sdk-ts
Class PartitionsRequest
Hierarchy
- PartitionsRequest
Index
Constructors
constructor
Returns PartitionsRequest
Methods
get
Gets additional fields for the request.
Returns undefined | AdditionalFields
The
partitionIdsstring.
get
Gets a billing tag to group billing records together.
Returns undefined | string
The
BillingTagstring.
get
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.Returns FetchOptions
The fetch option.
get
Gets partition IDs for the request.
Returns undefined | string[]
The
partitionIdsstring.
with
Sets the provided additional fields:
dataSize,checksum,compressedDataSize, andcrc.Parameters
additionalFields: AdditionalFields
The array of strings. The array can contain the following values:
dataSize,checksum,compressedDataSize, andcrc.
Returns PartitionsRequest
The updated PartitionsRequest instance that you can use to chain methods.
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 PartitionsRequest
The updated PartitionsRequest instance that you can use to chain methods.
with
Sets the fetch option that you can use to set the source from which data should be fetched.
Parameters
option: FetchOptions
The
FetchOptionenum.
Returns PartitionsRequest
A reference to the updated
PartitionsRequestinstance.
with
Sets the provided partition IDs.
Parameters
ids: string[]
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 PartitionsRequest
The updated PartitionsRequest instance that you can use to chain methods.
Generated using TypeDoc
Prepares information for calls to get partitions metadata from the Metadata Service API.