Encapsulates the fields required to prefetch a list of partitions for the given catalog and layer.
More...
#include <PrefetchPartitionsRequest.h>
|
|
using | PartitionIds = std::vector< std::string > |
| | An alias for the vector of partitions IDs.
|
| |
Encapsulates the fields required to prefetch a list of partitions for the given catalog and layer.
◆ CreateKey()
| std::string olp::dataservice::read::PrefetchPartitionsRequest::CreateKey |
( |
const std::string & |
layer_id, |
|
|
boost::optional< int64_t > |
version = boost::none |
|
) |
| const |
|
inline |
Creates a readable format for the request.
- Parameters
-
| layer_id | The ID of the layer that is used for the request. |
| version | The catalog version. |
- Returns
- A string representation of the request.
◆ GetBillingTag()
| const boost::optional<std::string>& olp::dataservice::read::PrefetchPartitionsRequest::GetBillingTag |
( |
| ) |
const |
|
inline |
Gets the billing tag to group billing records together.
The billing tag is 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].
- Returns
- The
BillingTag string or boost::none if the billing tag is not set.
◆ GetPartitionIds()
| const PartitionIds& olp::dataservice::read::PrefetchPartitionsRequest::GetPartitionIds |
( |
| ) |
const |
|
inline |
Gets the list of the partitions.
- Returns
- The vector of strings that represent partitions.
◆ GetPriority()
| uint32_t olp::dataservice::read::PrefetchPartitionsRequest::GetPriority |
( |
| ) |
const |
|
inline |
Gets the request priority.
The default priority is Priority::LOW.
- Returns
- The request priority.
◆ WithBillingTag() [1/2]
| PrefetchPartitionsRequest& olp::dataservice::read::PrefetchPartitionsRequest::WithBillingTag |
( |
boost::optional< std::string > |
billing_tag | ) |
|
|
inline |
Sets the billing tag for the request.
- See also
GetBillingTag() for information on usage and format.
- Parameters
-
| billing_tag | The BillingTag string or boost::none. |
- Returns
- A reference to the updated
PrefetchTilesRequest instance.
◆ WithBillingTag() [2/2]
Sets the billing tag for the request.
- See also
GetBillingTag() for information on usage and format.
- Parameters
-
| billing_tag | The rvalue reference to the BillingTag string or boost::none. |
- Returns
- A reference to the updated
PrefetchTilesRequest instance.
◆ WithPartitionIds()
Sets the list of partitions.
When the list is empty, the GetPartitions method will download the whole layer metadata. Additionally, a single request supports up to 100 partitions. If partitions list has more than 100, it will be split internally to multiple requests.
- Parameters
-
| partition_ids | The list of partitions to request. |
- Returns
- A reference to the updated
PrefetchPartitionsRequest instance.
◆ WithPriority()
Sets the priority of the prefetch request.
- Parameters
-
| priority | The priority of the request. |
- Returns
- A reference to the updated
PrefetchPartitionsRequest instance.
The documentation for this class was generated from the following file:
