Sends a list of SDII messages to a stream layer. More...

#include <PublishSdiiRequest.h>

Public Member Functions
	PublishSdiiRequest (const PublishSdiiRequest &)=default

	PublishSdiiRequest (PublishSdiiRequest &&)=default

PublishSdiiRequest &	operator= (const PublishSdiiRequest &)=default

PublishSdiiRequest &	operator= (PublishSdiiRequest &&)=default

std::shared_ptr< std::vector< unsigned char > >	GetSdiiMessageList () const
	Gets the SDII Message List data. More...

PublishSdiiRequest &	WithSdiiMessageList (const std::shared_ptr< std::vector< unsigned char >> &sdii_message_list)
	Sets the SDII Message List data. More...

PublishSdiiRequest &	WithSdiiMessageList (std::shared_ptr< std::vector< unsigned char >> &&sdii_message_list)
	Sets the SDII Message List data. More...

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

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

PublishSdiiRequest &	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 > &	GetTraceId () const
	Gets the trace ID of the request. More...

PublishSdiiRequest &	WithTraceId (const std::string &trace_id)
	Sets the trace ID of the request. More...

PublishSdiiRequest &	WithTraceId (std::string &&trace_id)
	Sets the trace ID of the request. More...

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

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

PublishSdiiRequest &	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...

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

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

Detailed Description

Sends a list of SDII messages to a stream layer.

SDII message data must be in the SDII Message List protobuf format. The maximum size is 20 MB. For more information, see the HERE platform Sensor Data Ingestion Interface documentation and schemas.

Note: The content-type for this request is always "application/x-protobuf".

Member Function Documentation

◆ GetBillingTag()

const boost::optional<std::string>& olp::dataservice::write::model::PublishSdiiRequest::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::PublishSdiiRequest::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.

◆ GetLayerId()

const std::string& olp::dataservice::write::model::PublishSdiiRequest::GetLayerId ( ) const

inline

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

Returns: The layer ID of the catalog.

◆ GetSdiiMessageList()

std::shared_ptr<std::vector<unsigned char> > olp::dataservice::write::model::PublishSdiiRequest::GetSdiiMessageList ( ) const

inline

Gets the SDII Message List data.

Returns: The SDII Message List data.

◆ GetTraceId()

const boost::optional<std::string>& olp::dataservice::write::model::PublishSdiiRequest::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]

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

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

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

PublishSdiiRequest& olp::dataservice::write::model::PublishSdiiRequest::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.

◆ WithLayerId() [1/2]

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

PublishSdiiRequest& olp::dataservice::write::model::PublishSdiiRequest::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.

◆ WithSdiiMessageList() [1/2]

PublishSdiiRequest& olp::dataservice::write::model::PublishSdiiRequest::WithSdiiMessageList ( const std::shared_ptr< std::vector< unsigned char >> & sdii_message_list )

inline

Sets the SDII Message List data.

Parameters

sdii_message_list The SDII Message List data encoded in the protobuf format according to the HERE platform SDII Message List schema. The maximum size is 20 MB.

◆ WithSdiiMessageList() [2/2]

PublishSdiiRequest& olp::dataservice::write::model::PublishSdiiRequest::WithSdiiMessageList ( std::shared_ptr< std::vector< unsigned char >> && sdii_message_list )

inline

Sets the SDII Message List data.

Parameters

sdii_message_list The rvalue reference to the SDII Message List data encoded in the protobuf format according to the HERE platform SDII Message List schema. The maximum size is 20 MB.

◆ WithTraceId() [1/2]

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

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetBillingTag()

◆ GetChecksum()

◆ GetLayerId()

◆ GetSdiiMessageList()

◆ GetTraceId()

◆ WithBillingTag() [1/2]

◆ WithBillingTag() [2/2]

◆ WithChecksum() [1/2]

◆ WithChecksum() [2/2]

◆ WithLayerId() [1/2]

◆ WithLayerId() [2/2]

◆ WithSdiiMessageList() [1/2]

◆ WithSdiiMessageList() [2/2]

◆ WithTraceId() [1/2]

◆ WithTraceId() [2/2]