Publishes data to a stream layer.
More...
#include <PublishDataRequest.h>
Publishes data to a stream layer.
◆ GetBillingTag()
| const boost::optional<std::string>& olp::dataservice::write::model::PublishDataRequest::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.
◆ GetChecksum()
| const boost::optional<std::string>& olp::dataservice::write::model::PublishDataRequest::GetChecksum |
( |
| ) |
const |
|
inline |
Gets the request checksum.
It is an SHA-256 hash that you can provide for validation against the calculated value on the request body hash. It verifies the integrity of your request and prevents modification by a third party. If not provided, it is created by the service. The SHA-256 hash consists of 256 bits or 64 chars.
- Returns
- The request checksum.
◆ GetData()
| std::shared_ptr<std::vector<unsigned char> > olp::dataservice::write::model::PublishDataRequest::GetData |
( |
| ) |
const |
|
inline |
Gets the data to be published to the HERE platform.
- Returns
- The data to be published.
◆ GetLayerId()
| const std::string& olp::dataservice::write::model::PublishDataRequest::GetLayerId |
( |
| ) |
const |
|
inline |
Gets the layer ID of the catalog where you want to store the data.
- Returns
- The layer ID of the catalog.
◆ GetTraceId()
| const boost::optional<std::string>& olp::dataservice::write::model::PublishDataRequest::GetTraceId |
( |
| ) |
const |
|
inline |
Gets the trace ID of the request.
It is a unique message ID, such as a UUID. You can use this ID to track your request and identify the message in the catalog.
- Returns
- The trace ID of the request.
◆ WithBillingTag() [1/2]
| PublishDataRequest& olp::dataservice::write::model::PublishDataRequest::WithBillingTag |
( |
const 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. |
◆ WithBillingTag() [2/2]
| PublishDataRequest& olp::dataservice::write::model::PublishDataRequest::WithBillingTag |
( |
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 rvalue reference to the BillingTag string or boost::none. |
◆ WithChecksum() [1/2]
| PublishDataRequest& olp::dataservice::write::model::PublishDataRequest::WithChecksum |
( |
const std::string & |
checksum | ) |
|
|
inline |
Sets the request checksum.
- See also
GetChecksum for information on the checksum.
- Parameters
-
| checksum | The request checksum. |
◆ WithChecksum() [2/2]
| PublishDataRequest& olp::dataservice::write::model::PublishDataRequest::WithChecksum |
( |
std::string && |
checksum | ) |
|
|
inline |
Sets the request checksum.
- See also
GetChecksum for information on the checksum.
- Parameters
-
| checksum | The rvalue reference to the request checksum. |
◆ WithData() [1/2]
| PublishDataRequest& olp::dataservice::write::model::PublishDataRequest::WithData |
( |
const std::shared_ptr< std::vector< unsigned char >> & |
data | ) |
|
|
inline |
Sets the data to be published to the HERE platform.
- Parameters
-
| data | The data to be published. |
◆ WithData() [2/2]
| PublishDataRequest& olp::dataservice::write::model::PublishDataRequest::WithData |
( |
std::shared_ptr< std::vector< unsigned char >> && |
data | ) |
|
|
inline |
Sets the data to be published to the HERE platform.
- Parameters
-
| data | The rvalue reference to the data to be published. |
◆ WithLayerId() [1/2]
| PublishDataRequest& olp::dataservice::write::model::PublishDataRequest::WithLayerId |
( |
const std::string & |
layer_id | ) |
|
|
inline |
Sets the layer ID of the catalog where you want to store the data.
Make sure the layer is of the stream type.
- Parameters
-
| layer_id | The layer ID of the catalog. |
◆ WithLayerId() [2/2]
| PublishDataRequest& olp::dataservice::write::model::PublishDataRequest::WithLayerId |
( |
std::string && |
layer_id | ) |
|
|
inline |
Sets the layer ID of the catalog where you want to store the data.
Make sure the layer is of the stream type.
- Parameters
-
| layer_id | The rvalue reference to the layer ID of the catalog. |
◆ WithTraceId() [1/2]
| PublishDataRequest& olp::dataservice::write::model::PublishDataRequest::WithTraceId |
( |
const std::string & |
trace_id | ) |
|
|
inline |
Sets the trace ID of the request.
- Parameters
-
| trace_id | A unique message ID, such as a UUID. If you want to define your ID, include it in the request. If you do not include an ID, it is generated during ingestion and included in the response. You can use this ID to track your request and identify the message in the catalog. |
◆ WithTraceId() [2/2]
| PublishDataRequest& olp::dataservice::write::model::PublishDataRequest::WithTraceId |
( |
std::string && |
trace_id | ) |
|
|
inline |
Sets the trace ID of the request.
- Parameters
-
| trace_id | The rvalue reference to the unique message ID, such as a UUID. If you want to define your ID, include it in the request. If you do not include an ID, it is generated during ingestion and included in the response. You can use this ID to track your request and identify the message in the catalog. |
The documentation for this class was generated from the following file:
