PartitionsRequest
Methods
get
- get
Fetch Option(): FetchOptions
-
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 FetchOptionsThe fetch option.
with
- with
Additional Fields(additionalFields: AdditionalFields): PartitionsRequest
-
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 PartitionsRequestThe updated PartitionsRequest instance that you can use to chain methods.
-
with
- with
Billing Tag(tag: string): PartitionsRequest
-
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].
ParametersReturns PartitionsRequestThe updated PartitionsRequest instance that you can use to chain methods.
with
- with
Fetch Option(option: FetchOptions): PartitionsRequest
-
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.Parameters-
option: FetchOptions
The
FetchOptionenum.
Returns PartitionsRequestA reference to the updated
PartitionsRequestinstance. -
with
- with
Partition Ids(ids: string[]): PartitionsRequest
-
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 PartitionsRequestThe updated PartitionsRequest instance that you can use to chain methods.
-
Prepares information for calls to get partitions metadata from the Metadata Service API.