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

Contains IDs that can be used to track your request and identify messages in a catalog. More...

#include <ResponseOk.h>

Public Member Functions

 TraceID (const TraceID &)=default
 
 TraceID (TraceID &&)=default
 
TraceIDoperator= (const TraceID &)=default
 
TraceIDoperator= (TraceID &&)=default
 
const std::string & GetParentID () const
 Gets the unique ID of the list of messages. More...
 
std::string & GetMutableParentID ()
 Gets a mutable reference to the unique ID of the list of messages. More...
 
void SetParentID (const std::string &value)
 Sets the unique ID for the list of messages. More...
 
const std::vector< std::string > & GetGeneratedIDs () const
 Gets the generated list of unique message IDs. More...
 
std::vector< std::string > & GetMutableGeneratedIDs ()
 Gets a mutable reference to the generated list of unique message IDs. More...
 
void SetGeneratedIDs (const std::vector< std::string > &value)
 Sets the generated list of unique message IDs. More...
 

Detailed Description

Contains IDs that can be used to track your request and identify messages in a catalog.

Member Function Documentation

◆ GetGeneratedIDs()

const std::vector<std::string>& olp::dataservice::write::model::TraceID::GetGeneratedIDs ( ) const
inline

Gets the generated list of unique message IDs.

You can use this ID to track your request and identify the message in the catalog.

Returns
The generated list of unique message IDs.

◆ GetMutableGeneratedIDs()

std::vector<std::string>& olp::dataservice::write::model::TraceID::GetMutableGeneratedIDs ( )
inline

Gets a mutable reference to the generated list of unique message IDs.

You can use this ID to track your request and identify the message in the catalog.

Returns
The mutable reference to the generated list of unique message IDs.

◆ GetMutableParentID()

std::string& olp::dataservice::write::model::TraceID::GetMutableParentID ( )
inline

Gets a mutable reference to the unique ID of the list of messages.

You can use this ID to track your request and identify the message in the catalog.

Returns
The mutable reference to the unique ID of the list of messages.

◆ GetParentID()

const std::string& olp::dataservice::write::model::TraceID::GetParentID ( ) const
inline

Gets the unique ID of the list of messages.

You can use this ID to track your request and identify each message in the catalog.

Returns
The unique ID of the list of messages.

◆ SetGeneratedIDs()

void olp::dataservice::write::model::TraceID::SetGeneratedIDs ( const std::vector< std::string > &  value)
inline

Sets the generated list of unique message IDs.

Parameters
valueThe generated list of unique message IDs.

◆ SetParentID()

void olp::dataservice::write::model::TraceID::SetParentID ( const std::string &  value)
inline

Sets the unique ID for the list of messages.

You can use this ID to track your request and identify the message in the catalog.

Parameters
valueThe unique ID to set.

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