olp::dataservice::read::model::StreamProperties Class Reference

Properties that define the scale of the required streaming service. More...

#include <Catalog.h>

Public Member Functions
	StreamProperties (const StreamProperties &)=default
	StreamProperties (StreamProperties &&)=default
StreamProperties &	operator= (const StreamProperties &)=default
StreamProperties &	operator= (StreamProperties &&)=default
const int64_t &	GetDataInThroughputMbps () const
	Gets the maximum throughput for the incoming data expressed in megabytes per second.
int64_t &	GetMutableDataInThroughputMbps ()
	Gets a mutable reference to the maximum throughput for the incoming data.
void	SetDataInThroughputMbps (const int64_t &value)
	Sets the maximum throughput for the incoming data.
const int64_t &	GetDataOutThroughputMbps () const
	Gets the maximum throughput for the outgoing data expressed in megabytes per second.
int64_t &	GetMutableDataOutThroughputMbps ()
	Gets a mutable reference to the maximum throughput for the outgoing data.
void	SetDataOutThroughputMbps (const int64_t &value)
	Sets the maximum throughput for the outgoing data.

Detailed Description

Properties that define the scale of the required streaming service.

Member Function Documentation

GetDataInThroughputMbps()

const int64_t & olp::dataservice::read::model::StreamProperties::GetDataInThroughputMbps ( ) const

inline

Gets the maximum throughput for the incoming data expressed in megabytes per second.

Throttling occurs when the inbound rate exceeds the maximum inbound throughput. The default value is 4 MBps. The maximum value is 32 MBps.

Returns

The maximum throughput for the incoming data.

GetDataOutThroughputMbps()

const int64_t & olp::dataservice::read::model::StreamProperties::GetDataOutThroughputMbps ( ) const

inline

Gets the maximum throughput for the outgoing data expressed in megabytes per second.

Throttling occurs when the total outbound rate to all consumers exceeds the maximum outbound throughput. The default value is 8 MBps. The maximum value is 64 MBps.

Returns

The maximum throughput for the outgoing data.

GetMutableDataInThroughputMbps()

int64_t & olp::dataservice::read::model::StreamProperties::GetMutableDataInThroughputMbps ( )

inline

Gets a mutable reference to the maximum throughput for the incoming data.

See also

GetDataInThroughputMbps for information on the maximum throughput for the incoming data.

Returns

The mutable reference to the maximum throughput for the incoming data.

GetMutableDataOutThroughputMbps()

int64_t & olp::dataservice::read::model::StreamProperties::GetMutableDataOutThroughputMbps ( )

inline

Gets a mutable reference to the maximum throughput for the outgoing data.

See also

GetDataOutThroughputMbps for information on the maximum throughput for the outgoing data.

Returns

The mutable reference to the maximum throughput for the outgoing data.

SetDataInThroughputMbps()

void olp::dataservice::read::model::StreamProperties::SetDataInThroughputMbps ( const int64_t &  value )

inline

Sets the maximum throughput for the incoming data.

See also

GetDataInThroughputMbps for information on the maximum throughput for the incoming data.

Parameters

value

The maximum throughput for the incoming data.

SetDataOutThroughputMbps()

void olp::dataservice::read::model::StreamProperties::SetDataOutThroughputMbps ( const int64_t &  value )

inline

Sets the maximum throughput for the outgoing data.

See also

GetDataOutThroughputMbps for information on the maximum throughput for the outgoing data.

Parameters

value

The maximum throughput for outgoing data

---

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

• olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/model/Catalog.h