A model that represents a partition in a layer. More...

#include <Partitions.h>

Public Member Functions
	Partition (const Partition &)=default

	Partition (Partition &&)=default

Partition &	operator= (const Partition &)=default

Partition &	operator= (Partition &&)=default

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

boost::optional< std::string > &	GetMutableChecksum ()
	(Optional) Gets a mutable reference to the partition checksum. More...

void	SetChecksum (boost::optional< std::string > value)
	(Optional) Sets the partition checksum. More...

const boost::optional< int64_t > &	GetCompressedDataSize () const
	(Optional) Gets the compressed size of the partition data in bytes when data compression is enabled. More...

boost::optional< int64_t > &	GetMutableCompressedDataSize ()
	(Optional) Gets a mutable reference to the compressed size of the partition data in bytes when data compression is enabled. More...

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

const std::string &	GetDataHandle () const
	Get the partition data handle. More...

std::string &	GetMutableDataHandle ()
	Gets a mutable reference to the partition data handle. More...

void	SetDataHandle (std::string value)
	Sets the partition data handle. More...

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

boost::optional< int64_t > &	GetMutableDataSize ()
	(Optional) Gets a mutable reference to the uncompressed size of the partition data in bytes. More...

void	SetDataSize (boost::optional< int64_t > value)
	(Optional) Sets the uncompressed size of the partition data. More...

const boost::optional< std::string > &	GetCrc () const

boost::optional< std::string > &	GetMutableCrc ()
	(Optional) Gets a mutable reference to the partition crc. More...

void	SetCrc (boost::optional< std::string > value)
	(Optional) Sets the partition crc. More...

const std::string &	GetPartition () const
	Gets the partition key. More...

std::string &	GetMutablePartition ()
	Gets a mutable reference to the partition key. More...

void	SetPartition (std::string value)
	Sets the partition key. More...

const boost::optional< int64_t > &	GetVersion () const
	(Optional) Gets the version of the catalog when this partition was last changed. More...

boost::optional< int64_t > &	GetMutableVersion ()
	(Optional) Gets a mutable reference to the version of the catalog when this partition was last changed. More...

void	SetVersion (boost::optional< int64_t > value)
	(Optional) Sets the partition version. More...

Detailed Description

A model that represents a partition in a layer.

Member Function Documentation

◆ GetChecksum()

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

inline

(Optional) Gets the partition checksum.

It is only provided to the API calls that explicitly request a checksum and only matches partitions that have a checksum defined. You can request partitions with a specific checksum by using the additionalFields query parameter. If you need to compare data sets for this catalog, set this field to match the SHA-1 checksum of the corresponding data blob. The maximum length of the checksum field is 128 characters.

Returns: The partition checksum.

◆ GetCompressedDataSize()

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

inline

(Optional) Gets the compressed size of the partition data in bytes when data compression is enabled.

It is only provided to the API calls that explicitly request the compressed data size and only matches partitions that have a compressed data size defined. You can request partitions with a specific compressed data size by using the additionalFields query parameter.

Returns: The compressed size of the partition data.

◆ GetCrc()

const boost::optional<std::string>& olp::dataservice::read::model::Partition::GetCrc ( ) const

inline

Optional value for the CRC of the partition data in bytes.

The response only includes the data size if you specify crc in the additionalFields query parameter, and if crc was specified in the partition metadata when it was published.

Returns: The partition CRC.

◆ GetDataHandle()

const std::string& olp::dataservice::read::model::Partition::GetDataHandle ( ) const

inline

Get the partition data handle.

You use the data handle to retrieve the data that relates to this partition. The data handle identifies a specific blob so that you can request the blob contents with the Blob API. When requesting data from the Blob API, you must specify the catalog ID, layer ID, and data handle.

Returns: The partition data handle.

◆ GetDataSize()

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

inline

(Optional) Gets the uncompressed size of the partition data in bytes.

It is only provided to the API calls that explicitly request the data size and only matches partitions that have a data size defined. You can request partitions with a specific data size by using the additionalFields query parameter.

Returns: The uncompressed size of the partition data

◆ GetMutableChecksum()

boost::optional<std::string>& olp::dataservice::read::model::Partition::GetMutableChecksum ( )

inline

(Optional) Gets a mutable reference to the partition checksum.

See also: GetChecksum for information on the checksum.

Returns: The mutable reference to the partition checksum.

◆ GetMutableCompressedDataSize()

boost::optional<int64_t>& olp::dataservice::read::model::Partition::GetMutableCompressedDataSize ( )

inline

(Optional) Gets a mutable reference to the compressed size of the partition data in bytes when data compression is enabled.

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

Returns: The mutable reference to the compressed size of the partition data.

◆ GetMutableCrc()

boost::optional<std::string>& olp::dataservice::read::model::Partition::GetMutableCrc ( )

inline

(Optional) Gets a mutable reference to the partition crc.

See also: GetCrc for information on the crc.

Returns: The mutable reference to the partition crc.

◆ GetMutableDataHandle()

std::string& olp::dataservice::read::model::Partition::GetMutableDataHandle ( )

inline

Gets a mutable reference to the partition data handle.

See also: GetPartition for information on the partition data handle.

Returns: The partition data handle.

◆ GetMutableDataSize()

boost::optional<int64_t>& olp::dataservice::read::model::Partition::GetMutableDataSize ( )

inline

(Optional) Gets a mutable reference to the uncompressed size of the partition data in bytes.

See also: GetDataSize for information on the uncompressed size of the partition data.

Returns: The mutable reference to the uncompressed size of the partition data.

◆ GetMutablePartition()

std::string& olp::dataservice::read::model::Partition::GetMutablePartition ( )

inline

Gets a mutable reference to the partition key.

See also: GetPartition for information on the partition key.

Returns: The mutable reference to the partition key.

◆ GetMutableVersion()

boost::optional<int64_t>& olp::dataservice::read::model::Partition::GetMutableVersion ( )

inline

(Optional) Gets a mutable reference to the version of the catalog when this partition was last changed.

See also: GetVersion for information on partition versions.

Returns: The mutable reference to the version of the catalog when this partition was last changed.

◆ GetPartition()

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

inline

Gets the partition key.

It is a unique key for a partition within a layer. If the layer partitioning scheme is HERE Tile, the partition key is equivalent to the tile key. The partition key cannot be empty. The maximum length of the partition key is 500 characters.

Returns: The partition key.

◆ GetVersion()

const boost::optional<int64_t>& olp::dataservice::read::model::Partition::GetVersion ( ) const

inline

(Optional) Gets the version of the catalog when this partition was last changed.

It is only provided for active versioned partitions.

Note: For volatile partitions, the version is always -1.

Returns: The version of the catalog when this partition was last changed.

◆ SetChecksum()

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

inline

(Optional) Sets the partition checksum.

See also: GetChecksum for information on the checksum.

Parameters

value The partition checksum.

◆ SetCompressedDataSize()

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

inline

(Optional) Sets the compressed size of the partition data.

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

Parameters

value The compressed size of the partition data.

◆ SetCrc()

void olp::dataservice::read::model::Partition::SetCrc ( boost::optional< std::string > value )

inline

(Optional) Sets the partition crc.

See also: GetCrc for information on the crc.

Parameters

value The partition crc.

◆ SetDataHandle()

void olp::dataservice::read::model::Partition::SetDataHandle ( std::string value )

inline

Sets the partition data handle.

See also: GetPartition for information on the partition data handle.

Parameters

value The partition data handle.

◆ SetDataSize()

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

inline

(Optional) Sets the uncompressed size of the partition data.

See also: GetDataSize for information on the uncompressed size of the partition data.

Parameters

value The uncompressed size of the partition data.

◆ SetPartition()

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

inline

Sets the partition key.

See also: GetPartition for information on the partition key.

Parameters

value The partition key.

◆ SetVersion()

void olp::dataservice::read::model::Partition::SetVersion ( boost::optional< int64_t > value )

inline

(Optional) Sets the partition version.

See also: GetVersion for information on partition versions.

Parameters

value The version of the catalog when this partition was last changed.

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetChecksum()

◆ GetCompressedDataSize()

◆ GetCrc()

◆ GetDataHandle()

◆ GetDataSize()

◆ GetMutableChecksum()

◆ GetMutableCompressedDataSize()

◆ GetMutableCrc()

◆ GetMutableDataHandle()

◆ GetMutableDataSize()

◆ GetMutablePartition()

◆ GetMutableVersion()

◆ GetPartition()

◆ GetVersion()

◆ SetChecksum()

◆ SetCompressedDataSize()

◆ SetCrc()

◆ SetDataHandle()

◆ SetDataSize()

◆ SetPartition()

◆ SetVersion()