olp::dataservice::read::ConsumerOption Class Reference

Represents a consumer configuration entry of one stream layer. More...

#include <ConsumerProperties.h>

Public Member Functions
	ConsumerOption (std::string key, std::string value)
	Creates the ConsumerOption instance. More...
	ConsumerOption (std::string key, const char *value)
	Creates the ConsumerOption instance. More...
	ConsumerOption (std::string key, int32_t value)
	Creates the ConsumerOption instance. More...
	ConsumerOption (std::string key, bool value)
	Creates the ConsumerOption instance. More...
const std::string &	GetKey () const
	Gets the key of the consumer configuration entry. More...
const std::string &	GetValue () const
	Gets the value of the consumer configuration entry. More...

Detailed Description

Represents a consumer configuration entry of one stream layer.

The accepted variable types are string, int32, or bool.

Constructor & Destructor Documentation

ConsumerOption() [1/4]

olp::dataservice::read::ConsumerOption::ConsumerOption ( std::string  key, std::string  value  )

inline

Creates the ConsumerOption instance.

Parameters

key	The string representation of the key.
value	The string representation of the key value.

ConsumerOption() [2/4]

olp::dataservice::read::ConsumerOption::ConsumerOption ( std::string  key, const char *  value  )

inline

Creates the ConsumerOption instance.

Parameters

key	The string representation of the key.
value	The string representation of the key value.

ConsumerOption() [3/4]

olp::dataservice::read::ConsumerOption::ConsumerOption ( std::string  key, int32_t  value  )

inline

Creates the ConsumerOption instance.

Parameters

key	The string representation of the key.
value	The value of the key represented as an integer.

ConsumerOption() [4/4]

olp::dataservice::read::ConsumerOption::ConsumerOption ( std::string  key, bool  value  )

inline

Creates the ConsumerOption instance.

Parameters

key	The string representation of the key.
value	The value of the key represented as a boolean.

Member Function Documentation

GetKey()

const std::string& olp::dataservice::read::ConsumerOption::GetKey ( ) const

inline

Gets the key of the consumer configuration entry.

Returns

The key of the consumer configuration entry.

GetValue()

const std::string& olp::dataservice::read::ConsumerOption::GetValue ( ) const

inline

Gets the value of the consumer configuration entry.

Returns

The value of the consumer configuration entry.

---

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

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