Publishes data to a versioned and volatile layer. More...

#include <PublishPartitionDataRequest.h>

Public Member Functions
	PublishPartitionDataRequest (const PublishPartitionDataRequest &)=default

	PublishPartitionDataRequest (PublishPartitionDataRequest &&)=default

PublishPartitionDataRequest &	operator= (const PublishPartitionDataRequest &)=default

PublishPartitionDataRequest &	operator= (PublishPartitionDataRequest &&)=default

std::shared_ptr< std::vector< unsigned char > >	GetData () const
	Gets the data to be published to the HERE platform. More...

PublishPartitionDataRequest &	WithData (const std::shared_ptr< std::vector< unsigned char >> &data)
	Sets the data to be published to the HERE platform. More...

PublishPartitionDataRequest &	WithData (std::shared_ptr< std::vector< unsigned char >> &&data)
	Sets the data to be published to the HERE platform. More...

const std::string &	GetLayerId () const
	Gets the layer ID of the catalog where you want to store the data. More...

PublishPartitionDataRequest &	WithLayerId (const std::string &layer_id)
	Sets the layer ID of the catalog where you want to store the data. More...

PublishPartitionDataRequest &	WithLayerId (std::string &&layer_id)
	Sets the layer ID of the catalog where you want to store the data. More...

const boost::optional< std::string > &	GetPartitionId () const
	Gets the ID of the partition to which you want to publish data. More...

PublishPartitionDataRequest &	WithPartitionId (const std::string &partition_id)
	Sets the ID of the partition to which you want to publish data. More...

PublishPartitionDataRequest &	WithPartitionId (std::string &&partition_id)
	Sets the ID of the partition to which you want to publish data. More...

const boost::optional< std::string > &	GetBillingTag () const
	Gets the billing tag to group billing records together. More...

PublishPartitionDataRequest &	WithBillingTag (const std::string &billing_tag)
	Sets the billing tag for the request. More...

PublishPartitionDataRequest &	WithBillingTag (std::string &&billing_tag)
	Sets the billing tag for the request. More...

const boost::optional< std::string > &	GetChecksum () const
	Gets the request checksum. More...

PublishPartitionDataRequest &	WithChecksum (const std::string &checksum)
	Sets the request checksum. More...

PublishPartitionDataRequest &	WithChecksum (std::string &&checksum)
	Sets the request checksum. More...

Detailed Description

Publishes data to a versioned and volatile layer.

Member Function Documentation

◆ GetBillingTag()

const boost::optional<std::string>& olp::dataservice::write::model::PublishPartitionDataRequest::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::PublishPartitionDataRequest::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::PublishPartitionDataRequest::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::PublishPartitionDataRequest::GetLayerId ( ) const

inline

Gets the layer ID of the catalog where you want to store the data.

Returns: The layer ID of the catalog.

◆ GetPartitionId()

const boost::optional<std::string>& olp::dataservice::write::model::PublishPartitionDataRequest::GetPartitionId ( ) const

inline

Gets the ID of the partition to which you want to publish data.

Returns: The partition ID.

◆ WithBillingTag() [1/2]

PublishPartitionDataRequest& olp::dataservice::write::model::PublishPartitionDataRequest::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]

PublishPartitionDataRequest& olp::dataservice::write::model::PublishPartitionDataRequest::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]

PublishPartitionDataRequest& olp::dataservice::write::model::PublishPartitionDataRequest::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]

PublishPartitionDataRequest& olp::dataservice::write::model::PublishPartitionDataRequest::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]

PublishPartitionDataRequest& olp::dataservice::write::model::PublishPartitionDataRequest::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]

PublishPartitionDataRequest& olp::dataservice::write::model::PublishPartitionDataRequest::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]

PublishPartitionDataRequest& olp::dataservice::write::model::PublishPartitionDataRequest::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 volative or versioned type.

Parameters

layer_id The layer ID of the catalog.

◆ WithLayerId() [2/2]

PublishPartitionDataRequest& olp::dataservice::write::model::PublishPartitionDataRequest::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 volative or versioned type.

Parameters

layer_id The rvalue reference to the layer ID of the catalog.

◆ WithPartitionId() [1/2]

PublishPartitionDataRequest& olp::dataservice::write::model::PublishPartitionDataRequest::WithPartitionId ( const std::string & partition_id )

inline

Sets the ID of the partition to which you want to publish data.

Parameters

partition_id A key that specifies the partition to which the content is related. If the layer partitioning scheme is set to HERE tile, the partition key is the tile key. The maximum length of the partition key is 500 characters.

◆ WithPartitionId() [2/2]

PublishPartitionDataRequest& olp::dataservice::write::model::PublishPartitionDataRequest::WithPartitionId ( std::string && partition_id )

inline

Sets the ID of the partition to which you want to publish data.

Parameters

partition_id A key that specifies the partition to which the content is related. If the layer partitioning scheme is set to HERE tile, the partition key is the tile key. The maximum length of the partition key is 500 characters.

The documentation for this class was generated from the following file:

olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/PublishPartitionDataRequest.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetBillingTag()

◆ GetChecksum()

◆ GetData()

◆ GetLayerId()

◆ GetPartitionId()

◆ WithBillingTag() [1/2]

◆ WithBillingTag() [2/2]

◆ WithChecksum() [1/2]

◆ WithChecksum() [2/2]

◆ WithData() [1/2]

◆ WithData() [2/2]

◆ WithLayerId() [1/2]

◆ WithLayerId() [2/2]

◆ WithPartitionId() [1/2]

◆ WithPartitionId() [2/2]