olp::dataservice::read::SubscribeRequest Class Reference

Used to subscribe to a stream layer. More...

#include <SubscribeRequest.h>

Public Types
enum class	SubscriptionMode : char { kSerial , kParallel }
	The subscription mode. More...

Public Member Functions
SubscribeRequest &	WithSubscriptionMode (SubscriptionMode mode)
	Sets the subscription mode for the request. More...
SubscriptionMode	GetSubscriptionMode () const
	Gets the subscription mode of the request. More...
SubscribeRequest &	WithSubscriptionId (boost::optional< SubscriptionId > subscription_id)
	(Optional) Sets the subscription ID used for the request. More...
const boost::optional< SubscriptionId > &	GetSubscriptionId () const
	Gets the subscription ID of the request. More...
SubscribeRequest &	WithConsumerId (boost::optional< std::string > consumer_id)
	(Optional) Sets the consumer ID used for the request. More...
const boost::optional< std::string > &	GetConsumerId () const
	Gets the consumer ID of the request. More...
SubscribeRequest &	WithConsumerProperties (boost::optional< ConsumerProperties > properties)
	Sets the consumer properties for the request. More...
const boost::optional< ConsumerProperties > &	GetConsumerProperties () const
	Gets the consumer properties of the request. More...

Detailed Description

Used to subscribe to a stream layer.

Member Enumeration Documentation

SubscriptionMode

enum olp::dataservice::read::SubscribeRequest::SubscriptionMode : char

strong

The subscription mode.

Enumerator
kSerial	A default option. The subscription mode used for applications that read smaller volumes of data with a single subscription.
kParallel	The subscription mode used for applications that read large volumes of data in a parallel manner.

Member Function Documentation

GetConsumerId()

const boost::optional<std::string>& olp::dataservice::read::SubscribeRequest::GetConsumerId ( ) const

inline

Gets the consumer ID of the request.

Returns

The consumer ID.

GetConsumerProperties()

const boost::optional<ConsumerProperties>& olp::dataservice::read::SubscribeRequest::GetConsumerProperties ( ) const

inline

Gets the consumer properties of the request.

Returns

The consumer properties.

GetSubscriptionId()

const boost::optional<SubscriptionId>& olp::dataservice::read::SubscribeRequest::GetSubscriptionId ( ) const

inline

Gets the subscription ID of the request.

Returns

The subscription ID.

GetSubscriptionMode()

SubscriptionMode olp::dataservice::read::SubscribeRequest::GetSubscriptionMode ( ) const

inline

Gets the subscription mode of the request.

Returns

The subscription mode.

WithConsumerId()

SubscribeRequest& olp::dataservice::read::SubscribeRequest::WithConsumerId ( boost::optional< std::string >  consumer_id )

inline

(Optional) Sets the consumer ID used for the request.

Generated by the HERE platform if missing. Must be UUID. Must be unique within the consumer group (group ID, HRN, layer ID, and application ID (AID)).

Parameters

consumer_id

The consumer ID.

Returns

A reference to the updated SubscribeRequest instance.

WithConsumerProperties()

SubscribeRequest& olp::dataservice::read::SubscribeRequest::WithConsumerProperties ( boost::optional< ConsumerProperties >  properties )

inline

Sets the consumer properties for the request.

See also

The Get Data from a Stream Layer section in the Data API Developer Guide.

Parameters

properties

The consumer properties.

Returns

A reference to the updated SubscribeRequest instance.

WithSubscriptionId()

SubscribeRequest& olp::dataservice::read::SubscribeRequest::WithSubscriptionId ( boost::optional< SubscriptionId >  subscription_id )

inline

(Optional) Sets the subscription ID used for the request.

Generated by the HERE platform if missing. Must be UUID. Must be unique within subscriptions.

Parameters

subscription_id

The subscription ID.

Returns

A reference to the updated SubscribeRequest instance.

WithSubscriptionMode()

SubscribeRequest& olp::dataservice::read::SubscribeRequest::WithSubscriptionMode ( SubscriptionMode  mode )

inline

Sets the subscription mode for the request.

The default value is kSerial.

Parameters

mode	The subscription mode.

Returns

A reference to the updated SubscribeRequest instance.

---

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

• olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/SubscribeRequest.h