iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder Class Reference

#include <ApiEventLoggerQueryParamsBuilder.hpp>

Inheritance diagram for iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder:

Collaboration diagram for iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder:

Classes
struct	Request

Public Member Functions
	ApiEventLoggerQueryParamsBuilder ()=default
std::optional< std::string >	getChannelId () const override
std::unordered_map< std::string_view, std::string >	build () const override
ApiEventLoggerQueryParamsBuilder &	setPaginationOffset (uint32_t paginationOffset)
ApiEventLoggerQueryParamsBuilder &	setPaginationLimit (uint32_t paginationLimit)
ApiEventLoggerQueryParamsBuilder &	setEventCategories (const std::set< std::string > &eventCategories)
ApiEventLoggerQueryParamsBuilder &	setStationsSource (const std::set< std::string > &stationsSource)
ApiEventLoggerQueryParamsBuilder &	setEventTypes (const std::set< std::string > &eventTypes)
ApiEventLoggerQueryParamsBuilder &	setUserProfilesIn (const std::set< std::string > &userProfilesIn)
ApiEventLoggerQueryParamsBuilder &	setUserProfilesOut (const std::set< std::string > &userProfilesOut)
ApiEventLoggerQueryParamsBuilder &	setIpAddresses (const std::set< std::string > &ipAddresses)
ApiEventLoggerQueryParamsBuilder &	setIpPorts (const std::set< std::string > &ipPorts)
ApiEventLoggerQueryParamsBuilder &	setUnitIds (const std::set< iv::types::unitId > &unitIds)
ApiEventLoggerQueryParamsBuilder &	setChannelIds (const std::set< iv::types::channelId > &channelIds)
ApiEventLoggerQueryParamsBuilder &	setGroupIds (const std::set< iv::types::groupId > &groupIds)
ApiEventLoggerQueryParamsBuilder &	setBackupNames (const std::set< std::string > &backupNames)
ApiEventLoggerQueryParamsBuilder &	setStartDate (iv::types::timestamp startDate)
ApiEventLoggerQueryParamsBuilder &	setEndDate (iv::types::timestamp endDate)

Static Protected Member Functions
static std::string	parseStringList (const std::set< std::string > &stringValues)
	Parse a set of string values into a single string.

Private Attributes
std::optional< uint32_t >	m_paginationOffset
std::optional< uint32_t >	m_paginationLimit
std::optional< std::set< std::string > >	m_eventCategories
std::optional< std::set< std::string > >	m_stationsSource
std::optional< std::set< std::string > >	m_eventTypes
std::optional< std::set< std::string > >	m_userProfilesIn
std::optional< std::set< std::string > >	m_userProfilesOut
std::optional< std::set< std::string > >	m_ipAddresses
std::optional< std::set< std::string > >	m_ipPorts
std::optional< std::set< iv::types::unitId > >	m_unitIds
std::optional< std::set< iv::types::channelId > >	m_channelIds
std::optional< std::set< iv::types::groupId > >	m_groupIds
std::optional< std::set< std::string > >	m_backupNames
std::optional< iv::types::timestamp >	m_startDate
std::optional< iv::types::timestamp >	m_endDate

Constructor & Destructor Documentation

ApiEventLoggerQueryParamsBuilder()

iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::ApiEventLoggerQueryParamsBuilder ( )

default

Member Function Documentation

build()

std::unordered_map< std::string_view, std::string > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::build ( ) const

nodiscardoverridevirtual

Implements iv::comms::api::IApiQueryParamsBuilder.

getChannelId()

std::optional< std::string > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::getChannelId ( ) const

inlinenodiscardoverridevirtual

Implements iv::comms::api::IApiQueryParamsBuilder.

parseStringList()

static std::string iv::comms::api::IApiQueryParamsBuilder::parseStringList ( const std::set< std::string > & stringValues )

inlinestaticprotectedinherited

Parse a set of string values into a single string.

Parameters

stringValues

Set of string values.

Returns

Parsed string with values separated by commas.

setBackupNames()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setBackupNames

(

const std::set< std::string > &

backupNames

)

setChannelIds()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setChannelIds

(

const std::set< iv::types::channelId > &

channelIds

)

setEndDate()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setEndDate

(

iv::types::timestamp

endDate

)

setEventCategories()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setEventCategories

(

const std::set< std::string > &

eventCategories

)

setEventTypes()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setEventTypes

(

const std::set< std::string > &

eventTypes

)

setGroupIds()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setGroupIds

(

const std::set< iv::types::groupId > &

groupIds

)

setIpAddresses()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setIpAddresses

(

const std::set< std::string > &

ipAddresses

)

setIpPorts()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setIpPorts

(

const std::set< std::string > &

ipPorts

)

setPaginationLimit()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setPaginationLimit

(

uint32_t

paginationLimit

)

setPaginationOffset()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setPaginationOffset

(

uint32_t

paginationOffset

)

setStartDate()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setStartDate

(

iv::types::timestamp

startDate

)

setStationsSource()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setStationsSource

(

const std::set< std::string > &

stationsSource

)

setUnitIds()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setUnitIds

(

const std::set< iv::types::unitId > &

unitIds

)

setUserProfilesIn()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setUserProfilesIn

(

const std::set< std::string > &

userProfilesIn

)

setUserProfilesOut()

ApiEventLoggerQueryParamsBuilder & iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::setUserProfilesOut

(

const std::set< std::string > &

userProfilesOut

)

Member Data Documentation

m_backupNames

std::optional<std::set<std::string> > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_backupNames

private

m_channelIds

std::optional<std::set<iv::types::channelId> > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_channelIds

private

m_endDate

std::optional<iv::types::timestamp> iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_endDate

private

m_eventCategories

std::optional<std::set<std::string> > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_eventCategories

private

m_eventTypes

std::optional<std::set<std::string> > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_eventTypes

private

m_groupIds

std::optional<std::set<iv::types::groupId> > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_groupIds

private

m_ipAddresses

std::optional<std::set<std::string> > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_ipAddresses

private

m_ipPorts

std::optional<std::set<std::string> > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_ipPorts

private

m_paginationLimit

std::optional<uint32_t> iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_paginationLimit

private

m_paginationOffset

std::optional<uint32_t> iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_paginationOffset

private

m_startDate

std::optional<iv::types::timestamp> iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_startDate

private

m_stationsSource

std::optional<std::set<std::string> > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_stationsSource

private

m_unitIds

std::optional<std::set<iv::types::unitId> > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_unitIds

private

m_userProfilesIn

std::optional<std::set<std::string> > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_userProfilesIn

private

m_userProfilesOut

std::optional<std::set<std::string> > iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder::m_userProfilesOut

private

---

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

• src/comms/apis/eventLogger/ApiEventLoggerQueryParamsBuilder.hpp
• src/comms/apis/eventLogger/ApiEventLoggerQueryParamsBuilder.cpp