olp::dataservice::read::model::IndexProperties Class Reference

A model that represents index properties. More...

#include <Catalog.h>

Public Member Functions
	IndexProperties (const IndexProperties &)=default
	IndexProperties (IndexProperties &&)=default
IndexProperties &	operator= (const IndexProperties &)=default
IndexProperties &	operator= (IndexProperties &&)=default
const std::string &	GetTtl () const
	Gets the expiry time (in milliseconds) for data in the index layer. More...
std::string &	GetMutableTtl ()
	Gets a mutable reference to the expiry time for data in the index layer. More...
void	SetTtl (const std::string &value)
	Sets the expiry time for the data in the index layer. More...
const std::vector< IndexDefinition > &	GetIndexDefinitions () const
	Gets the IndexDefinition instance. More...
std::vector< IndexDefinition > &	GetMutableIndexDefinitions ()
	Gets a mutable reference to the IndexDefinition instance. More...
void	SetIndexDefinitions (const std::vector< IndexDefinition > &value)
	Sets the IndexDefinition instance. More...

Detailed Description

A model that represents index properties.

Member Function Documentation

GetIndexDefinitions()

const std::vector<IndexDefinition>& olp::dataservice::read::model::IndexProperties::GetIndexDefinitions ( ) const

inline

Gets the IndexDefinition instance.

Returns

The IndexDefinition instance.

GetMutableIndexDefinitions()

std::vector<IndexDefinition>& olp::dataservice::read::model::IndexProperties::GetMutableIndexDefinitions ( )

inline

Gets a mutable reference to the IndexDefinition instance.

Returns

The mutable reference to the IndexDefinition instance.

GetMutableTtl()

std::string& olp::dataservice::read::model::IndexProperties::GetMutableTtl ( )

inline

Gets a mutable reference to the expiry time for data in the index layer.

See also

GetTtl for information of the expiry time.

Returns

The mutable reference to the expiry time for the data in the index layer.

GetTtl()

const std::string& olp::dataservice::read::model::IndexProperties::GetTtl ( ) const

inline

Gets the expiry time (in milliseconds) for data in the index layer.

The default value is 604800000 (7 days).

Returns

The expiry time (in milliseconds) for the data in the index layer.

SetIndexDefinitions()

void olp::dataservice::read::model::IndexProperties::SetIndexDefinitions ( const std::vector< IndexDefinition > &  value )

inline

Sets the IndexDefinition instance.

Parameters

value

The IndexDefinition instance.

SetTtl()

void olp::dataservice::read::model::IndexProperties::SetTtl ( const std::string &  value )

inline

Sets the expiry time for the data in the index layer.

See also

GetTtl for information of the expiry time.

Parameters

value

The expiry time for the data in the index layer.

---

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

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