Encapsulates information about actual data content. More...

#include <Messages.h>

Public Member Functions
const std::string &	GetPartition () const
	Gets the partition of this metadata. More...

void	SetPartition (std::string value)
	Sets the partition ID of this metadata content. More...

const boost::optional< std::string > &	GetChecksum () const
	(Optional) Gets the checksum of this metadata. More...

void	SetChecksum (boost::optional< std::string > value)
	(Optional) Sets the checksum of this metadata content. More...

const boost::optional< int64_t > &	GetCompressedDataSize () const
	(Optional) Gets the compressed size of the content (in bytes). More...

void	SetCompressedDataSize (boost::optional< int64_t > value)
	(Optional) Sets the compressed size of the content. More...

const boost::optional< int64_t > &	GetDataSize () const
	(Optional) Gets the nominal size (in bytes) of the content. More...

void	SetDataSize (boost::optional< int64_t > value)
	(Optional) Sets the nominal size of the content. More...

const Data &	GetData () const
	Gets the data of this `Metadata` instance. More...

void	SetData (Data value)
	Sets the data of this content. More...

const boost::optional< std::string > &	GetDataHandle () const
	(Optional) Gets the data handle created when the content was uploaded. More...

void	SetDataHandle (boost::optional< std::string > value)
	(Optional) Sets the data handle of this content. More...

const boost::optional< int64_t > &	GetTimestamp () const
	(Optional) Get the timestamp of the content. More...

void	SetTimestamp (boost::optional< int64_t > value)
	(Optional) Sets the timestamp of the content. More...

Detailed Description

Encapsulates information about actual data content.

Member Function Documentation

◆ GetChecksum()

const boost::optional<std::string>& olp::dataservice::read::model::Metadata::GetChecksum ( ) const

inline

(Optional) Gets the checksum of this metadata.

The algorithm used to calculate the checksum is user-specific. It is not a secure hash. It is used only to detect changes in the content.

Examples: MD5 or SHA1

Returns: The checksum of the content.

◆ GetCompressedDataSize()

const boost::optional<int64_t>& olp::dataservice::read::model::Metadata::GetCompressedDataSize ( ) const

inline

(Optional) Gets the compressed size of the content (in bytes).

It is present only if the GetDataHandle method is not empty. Applicable also if Content-Encoding is set to gzip when uploading and downloading data.

Returns: The compressed size of the content (in bytes).

◆ GetData()

const Data& olp::dataservice::read::model::Metadata::GetData ( ) const

inline

Gets the data of this Metadata instance.

The data represents content published directly in the metadata and encoded in Base64. The size of the content is limited. It is present only if the message size is less than or equal to 1 MB.

Returns: The data of this message represented as a vector of bytes.

◆ GetDataHandle()

const boost::optional<std::string>& olp::dataservice::read::model::Metadata::GetDataHandle ( ) const

inline

(Optional) Gets the data handle created when the content was uploaded.

The data handle is a unique identifier that is used to identify this content and retrieve the content at a later stage.

Example: 1b2ca68f-d4a0-4379-8120-cd025640510c

Note: It is present only if the message size is less than or equal to 1 MB.

Returns: The data handle created when the content was uploaded.

◆ GetDataSize()

const boost::optional<int64_t>& olp::dataservice::read::model::Metadata::GetDataSize ( ) const

inline

(Optional) Gets the nominal size (in bytes) of the content.

It is present only if the GetDataHandle method is not empty.

Note: When compression is enabled, this field contains the size of the uncompressed content.

Returns: The data size in bytes.

◆ GetPartition()

const std::string& olp::dataservice::read::model::Metadata::GetPartition ( ) const

inline

Gets the partition of this metadata.

For more information on partitions, see the related section in the Data User Guide.

Returns: The partition to which this metadata content is related.

◆ GetTimestamp()

const boost::optional<int64_t>& olp::dataservice::read::model::Metadata::GetTimestamp ( ) const

inline

(Optional) Get the timestamp of the content.

This field represents time (in milliseconds since the Unix epoch) when this message was produced to the stream layer.

Returns: The Unix timestamp of the content (in milliseconds).

◆ SetChecksum()

void olp::dataservice::read::model::Metadata::SetChecksum ( boost::optional< std::string > value )

inline

(Optional) Sets the checksum of this metadata content.

See also: GetChecksum for information on the checksum.

Parameters

value The checksum string.

◆ SetCompressedDataSize()

void olp::dataservice::read::model::Metadata::SetCompressedDataSize ( boost::optional< int64_t > value )

inline

(Optional) Sets the compressed size of the content.

See also: GetCompressedDataSize for information on the compressed size of content.

Parameters

value The compressed size of the content (in bytes).

◆ SetData()

void olp::dataservice::read::model::Metadata::SetData ( Data value )

inline

Sets the data of this content.

Parameters

value The data of this content represented as a vector of bytes.

◆ SetDataHandle()

void olp::dataservice::read::model::Metadata::SetDataHandle ( boost::optional< std::string > value )

inline

(Optional) Sets the data handle of this content.

See also: GetDataHandle for information on the data handle.

Parameters

value The data handle represented as a string.

◆ SetDataSize()

void olp::dataservice::read::model::Metadata::SetDataSize ( boost::optional< int64_t > value )

inline

(Optional) Sets the nominal size of the content.

See also: GetDataSize for information on the nominal content size.

Parameters

value The nominal size of the content in bytes.

◆ SetPartition()

void olp::dataservice::read::model::Metadata::SetPartition ( std::string value )

inline

Sets the partition ID of this metadata content.

Parameters

value The partition ID string. The maximum length is 500 characters.

◆ SetTimestamp()

void olp::dataservice::read::model::Metadata::SetTimestamp ( boost::optional< int64_t > value )

inline

(Optional) Sets the timestamp of the content.

See also: GetTimeStamp for information on the timestamp.

Parameters

value The Unix timestamp of the content (in milliseconds).

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

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/model/Messages.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetChecksum()

◆ GetCompressedDataSize()

◆ GetData()

◆ GetDataHandle()

◆ GetDataSize()

◆ GetPartition()

◆ GetTimestamp()

◆ SetChecksum()

◆ SetCompressedDataSize()

◆ SetData()

◆ SetDataHandle()

◆ SetDataSize()

◆ SetPartition()

◆ SetTimestamp()