Encapsulates the fields required to request catalog configuration.
More...
#include <CatalogVersionRequest.h>
Encapsulates the fields required to request catalog configuration.
◆ CreateKey()
| std::string olp::dataservice::read::CatalogVersionRequest::CreateKey |
( |
| ) |
const |
|
inline |
Creates a readable format of the request.
- Returns
- A string representation of the request.
◆ GetBillingTag()
| const boost::optional<std::string>& olp::dataservice::read::CatalogVersionRequest::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.
◆ GetFetchOption()
| FetchOptions olp::dataservice::read::CatalogVersionRequest::GetFetchOption |
( |
| ) |
const |
|
inline |
Gets the fetch option that controls how requests are handled.
The default option is OnlineIfNotFound that queries the network if the requested resource is not in the cache.
- Returns
- The fetch option.
◆ GetStartVersion()
| int64_t olp::dataservice::read::CatalogVersionRequest::GetStartVersion |
( |
| ) |
const |
|
inline |
Gets the catalog start version (exclusive) for the request.
Mandatory for versioned layers. By convention -1 indicates the initial version before the first publication. After the first publication, the catalog version is 0.
- Returns
- The catalog start version.
◆ WithBillingTag() [1/2]
| CatalogVersionRequest& olp::dataservice::read::CatalogVersionRequest::WithBillingTag |
( |
boost::optional< std::string > |
billingTag | ) |
|
|
inline |
Sets the billing tag for the request.
- See also
GetBillingTag() for information on usage and format.
- Parameters
-
| billingTag | The BillingTag string or boost::none. |
- Returns
- A reference to the updated
CatalogVersionRequest instance.
◆ WithBillingTag() [2/2]
| CatalogVersionRequest& olp::dataservice::read::CatalogVersionRequest::WithBillingTag |
( |
std::string && |
billingTag | ) |
|
|
inline |
Sets the billing tag for the request.
- See also
GetBillingTag() for information on usage and format.
- Parameters
-
| billingTag | The rvalue reference to the BillingTag string or boost::none. |
- Returns
- A reference to the updated
CatalogVersionRequest instance.
◆ WithFetchOption()
| CatalogVersionRequest& olp::dataservice::read::CatalogVersionRequest::WithFetchOption |
( |
FetchOptions |
fetchoption | ) |
|
|
inline |
Sets the fetch option that you can use to set the source from which data should be fetched.
- See also
GetFetchOption() for information on usage and format.
- Parameters
-
| fetchoption | The FetchOption enum. |
- Returns
- A reference to the updated
CatalogVersionRequest instance.
◆ WithStartVersion()
| CatalogVersionRequest& olp::dataservice::read::CatalogVersionRequest::WithStartVersion |
( |
int64_t |
startVersion | ) |
|
|
inline |
Sets the catalog start version.
- See also
GetStartVersion() for information on usage.
- Parameters
-
| startVersion | The catalog start version. |
- Returns
- A reference to the updated
CatalogVersionRequest instance.
The documentation for this class was generated from the following file:
