Encapsulates the fields required to request catalog configuration.
More...
#include <CatalogRequest.h>
|
| const porting::optional< std::string > & | GetBillingTag () const |
| | Gets the billing tag to group billing records together.
|
| |
| template<class T = porting::optional<std::string>> |
| CatalogRequest & | WithBillingTag (T &&tag) |
| | Sets the billing tag for the request.
|
| |
| FetchOptions | GetFetchOption () const |
| | Gets the fetch option that controls how requests are handled.
|
| |
| CatalogRequest & | WithFetchOption (const FetchOptions fetch_option) |
| | Sets the fetch option that you can use to set the source from which data should be fetched.
|
| |
| std::string | CreateKey () const |
| | Creates a readable format of the request.
|
| |
Encapsulates the fields required to request catalog configuration.
◆ CreateKey()
| std::string olp::dataservice::read::CatalogRequest::CreateKey |
( |
| ) |
const |
|
inline |
Creates a readable format of the request.
- Returns
- A string representation of the request.
◆ GetBillingTag()
| const porting::optional< std::string > & olp::dataservice::read::CatalogRequest::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 olp::porting::none if the billing tag is not set.
◆ GetFetchOption()
| FetchOptions olp::dataservice::read::CatalogRequest::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.
◆ WithBillingTag()
template<class T = porting::optional<std::string>>
| CatalogRequest & olp::dataservice::read::CatalogRequest::WithBillingTag |
( |
T && |
tag | ) |
|
|
inline |
Sets the billing tag for the request.
- See also
GetBillingTag() for information on usage and format.
- Parameters
-
| tag | The BillingTag string or olp::porting::none. |
- Returns
- A reference to the updated
CatalogRequest instance.
◆ WithFetchOption()
| CatalogRequest & olp::dataservice::read::CatalogRequest::WithFetchOption |
( |
const FetchOptions |
fetch_option | ) |
|
|
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
-
| fetch_option | The FetchOption enum. |
- Returns
- A reference to the updated
CatalogVersionRequest instance.
The documentation for this class was generated from the following file:
