olp-cpp-sdk  1.22.0
Public Member Functions | List of all members
olp::dataservice::write::model::FlushRequest Class Reference

Flushes requests in a stream layer. More...

#include <FlushRequest.h>

Public Member Functions

 FlushRequest (const FlushRequest &)=default
 
 FlushRequest (FlushRequest &&)=default
 
FlushRequestoperator= (const FlushRequest &)=default
 
FlushRequestoperator= (FlushRequest &&)=default
 
int GetNumberOfRequestsToFlush () const
 Gets the number of partitions (PublishDataRequest) to be flushed. More...
 
FlushRequestWithNumberOfRequestsToFlush (int num_requests)
 Sets the number of partitions (PublishDataRequest) to be flushed. More...
 

Detailed Description

Flushes requests in a stream layer.

Member Function Documentation

◆ GetNumberOfRequestsToFlush()

int olp::dataservice::write::model::FlushRequest::GetNumberOfRequestsToFlush ( ) const
inline

Gets the number of partitions (PublishDataRequest) to be flushed.

The default value is 0, which means that all queued StreamLayerClient requests are flushed.

Returns
The number of publish data requests.

◆ WithNumberOfRequestsToFlush()

FlushRequest& olp::dataservice::write::model::FlushRequest::WithNumberOfRequestsToFlush ( int  num_requests)
inline

Sets the number of partitions (PublishDataRequest) to be flushed.

Parameters
num_requestsThe maximum number of partitions be flushed by StreamLayerClient. If the value is negative, nothing is flushed. To flush all requests, set the value to 0.

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