olp::dataservice::write::model::Index Class Reference

Represents the index layer. More...

#include <Index.h>

Public Member Functions
	Index ()=default
	A default constructor.
	Index (std::string uuid, std::map< IndexName, std::shared_ptr< IndexValue >> indexFields)
	Creates the Index insatnce. More...
const boost::optional< std::string > &	GetCheckSum () const
	Gets the checksum of the index layer. More...
boost::optional< std::string > &	GetMutableCheckSum ()
	Gets a mutable reference to the checksum of the index layer. More...
void	SetCheckSum (const std::string &value)
	Sets the checksum. More...
const boost::optional< std::map< std::string, std::string > > &	GetMetadata () const
	Gets the metadata of the index layer. More...
boost::optional< std::map< std::string, std::string > > &	GetMutableMetadata ()
	Gets a mutable reference to the metadata of the index layer. More...
void	SetMetadata (const std::map< std::string, std::string > &value)
	Sets the metadata of the index layer. More...
const std::string &	GetId () const
	Gets the index layer ID. More...
std::string &	GetMutableId ()
	Gets a mutable reference to the index layer ID. More...
void	SetId (const std::string &value)
	Sets the index layer ID. More...
const std::map< IndexName, std::shared_ptr< IndexValue > > &	GetIndexFields () const
	Gets the index value type. More...
std::map< IndexName, std::shared_ptr< IndexValue > > &	GetMutableIndexFields ()
	Gets a mutable reference to the index value type. More...
void	SetIndexFields (const std::map< IndexName, std::shared_ptr< IndexValue >> &value)
	Sets the index value type. More...
const boost::optional< int64_t > &	GetSize () const
	Gets the size of the index layer. More...
boost::optional< int64_t > &	GetMutableSize ()
	Gets a mutable reference to the size of the index layer. More...
void	SetSize (const int64_t &value)
	Sets the size of the index layer. More...

Detailed Description

Represents the index layer.

Constructor & Destructor Documentation

Index()

olp::dataservice::write::model::Index::Index ( std::string  uuid, std::map< IndexName, std::shared_ptr< IndexValue >>  indexFields  )

inline

Creates the Index insatnce.

Parameters

uuid	The unique ID.
indexFields	The index value type.

Member Function Documentation

GetCheckSum()

const boost::optional<std::string>& olp::dataservice::write::model::Index::GetCheckSum ( ) const

inline

Gets the checksum of the index layer.

Returns

The checksum.

GetId()

const std::string& olp::dataservice::write::model::Index::GetId ( ) const

inline

Gets the index layer ID.

Returns

The index layer ID.

GetIndexFields()

const std::map<IndexName, std::shared_ptr<IndexValue> >& olp::dataservice::write::model::Index::GetIndexFields ( ) const

inline

Gets the index value type.

Returns

The index value type.

GetMetadata()

const boost::optional<std::map<std::string, std::string> >& olp::dataservice::write::model::Index::GetMetadata ( ) const

inline

Gets the metadata of the index layer.

Returns

The metadata of the index layer.

GetMutableCheckSum()

boost::optional<std::string>& olp::dataservice::write::model::Index::GetMutableCheckSum ( )

inline

Gets a mutable reference to the checksum of the index layer.

Returns

The mutable reference to the checksum.

GetMutableId()

std::string& olp::dataservice::write::model::Index::GetMutableId ( )

inline

Gets a mutable reference to the index layer ID.

Returns

The mutable reference to the index layer ID.

GetMutableIndexFields()

std::map<IndexName, std::shared_ptr<IndexValue> >& olp::dataservice::write::model::Index::GetMutableIndexFields ( )

inline

Gets a mutable reference to the index value type.

Returns

The mutable reference to the index value type.

GetMutableMetadata()

boost::optional<std::map<std::string, std::string> >& olp::dataservice::write::model::Index::GetMutableMetadata ( )

inline

Gets a mutable reference to the metadata of the index layer.

Returns

The mutable reference to the metadata.

GetMutableSize()

boost::optional<int64_t>& olp::dataservice::write::model::Index::GetMutableSize ( )

inline

Gets a mutable reference to the size of the index layer.

Returns

The mutable reference to the size of the index layer.

GetSize()

const boost::optional<int64_t>& olp::dataservice::write::model::Index::GetSize ( ) const

inline

Gets the size of the index layer.

Returns

The size of the index layer.

SetCheckSum()

void olp::dataservice::write::model::Index::SetCheckSum ( const std::string &  value )

inline

Sets the checksum.

Parameters

value

The checksum.

SetId()

void olp::dataservice::write::model::Index::SetId ( const std::string &  value )

inline

Sets the index layer ID.

Parameters

value

The index layer ID.

SetIndexFields()

void olp::dataservice::write::model::Index::SetIndexFields ( const std::map< IndexName, std::shared_ptr< IndexValue >> &  value )

inline

Sets the index value type.

Parameters

value

The index vale type.

SetMetadata()

void olp::dataservice::write::model::Index::SetMetadata ( const std::map< std::string, std::string > &  value )

inline

Sets the metadata of the index layer.

Parameters

value

The metadata of the index layer.

SetSize()

void olp::dataservice::write::model::Index::SetSize ( const int64_t &  value )

inline

Sets the size of the index layer.

Parameters

value

The size of the index layer.

---

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

• olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/generated/model/Index.h