Publishes data to an index layer.
More...
#include <PublishIndexRequest.h>
Publishes data to an index layer.
◆ GetBillingTag()
| const boost::optional<std::string>& olp::dataservice::write::model::PublishIndexRequest::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::PublishIndexRequest::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::PublishIndexRequest::GetData |
( |
| ) |
const |
|
inline |
Gets the data to be published to the HERE platform.
- Returns
- The data to be published.
◆ GetIndex()
| const Index& olp::dataservice::write::model::PublishIndexRequest::GetIndex |
( |
| ) |
const |
|
inline |
Gets the Index object that contains the index information to be published to the index layer.
It consists of the following fields: metadata, ID, types of index fields, and size.
- See also
Index for more information.
- Returns
- The
Index object.
◆ GetLayerId()
| const std::string& olp::dataservice::write::model::PublishIndexRequest::GetLayerId |
( |
| ) |
const |
|
inline |
Gets the layer ID of the catalog where you want to store the data.
- Returns
- The layer ID of the catalog.
◆ WithBillingTag() [1/2]
| PublishIndexRequest& olp::dataservice::write::model::PublishIndexRequest::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 rvalue reference to the BillingTag string or boost::none. |
◆ WithBillingTag() [2/2]
| PublishIndexRequest& olp::dataservice::write::model::PublishIndexRequest::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]
| PublishIndexRequest& olp::dataservice::write::model::PublishIndexRequest::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]
| PublishIndexRequest& olp::dataservice::write::model::PublishIndexRequest::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]
| PublishIndexRequest& olp::dataservice::write::model::PublishIndexRequest::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]
| PublishIndexRequest& olp::dataservice::write::model::PublishIndexRequest::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. |
◆ WithIndex() [1/2]
Sets the Index object.
- See also
Index for more information.
- Parameters
-
◆ WithIndex() [2/2]
Sets the Index object.
- See also
Index for more information.
- Parameters
-
| index | The rvalue reference to the Index object. |
◆ WithLayerId() [1/2]
| PublishIndexRequest& olp::dataservice::write::model::PublishIndexRequest::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 index type.
- Parameters
-
| layer_id | The layer ID of the catalog. |
◆ WithLayerId() [2/2]
| PublishIndexRequest& olp::dataservice::write::model::PublishIndexRequest::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 index type.
- Parameters
-
| layer_id | The rvalue reference to the layer ID of the catalog. |
The documentation for this class was generated from the following file:
