A layer of a catalog. More...

#include <Catalog.h>

Public Member Functions
	Layer (const Layer &)=default

	Layer (Layer &&)=default

Layer &	operator= (const Layer &)=default

Layer &	operator= (Layer &&)=default

const std::string &	GetId () const
	Gets the ID that is used to refer to this layer programmatically. More...

std::string &	GetMutableId ()
	Gets a mutable reference to the ID that is used to refer to this layer programmatically. More...

void	SetId (const std::string &value)
	Sets the layer ID. More...

const std::string &	GetName () const
	Gets the layer display name. More...

std::string &	GetMutableName ()
	Gets a mutable refrence to the layer display name. More...

void	SetName (const std::string &value)
	Sets the layer display name. More...

const std::string &	GetSummary () const
	Gets the one-sentence summary of the layer. More...

std::string &	GetMutableSummary ()
	Gets a mutable reference to the one-sentence summary of the layer. More...

void	SetSummary (const std::string &value)
	Sets the layer summary. More...

const std::string &	GetDescription () const
	Gets the detailed description of the layer. More...

std::string &	GetMutableDescription ()
	Gets a mutable reference to the detailed description of the layer. More...

void	SetDescription (const std::string &value)
	Sets the detailed description of the layer. More...

const Owner &	GetOwner () const
	Gets the `Owner` instance. More...

Owner &	GetMutableOwner ()
	Gets a mutable reference to the `Owner` instance. More...

void	SetOwner (const Owner &value)
	Sets the `Owner` instance. More...

const Coverage &	GetCoverage () const
	Gets the `Coverage` instance. More...

Coverage &	GetMutableCoverage ()
	Gets a mutable reference to the `Coverage` instance. More...

void	SetCoverage (const Coverage &value)
	Sets the `Coverage` instance. More...

const Schema &	GetSchema () const
	Gets the `Schema` instance. More...

Schema &	GetMutableSchema ()
	Gets a mutable reference to the `Schema` instance. More...

void	SetSchema (const Schema &value)
	Sets the `Schema` instance. More...

const std::string &	GetContentType () const
	Gets the data of the MIME type that is stored in the layer. More...

std::string &	GetMutableContentType ()
	Gets a mutable reference to the data of the MIME type that is stored in the layer. More...

void	SetContentType (const std::string &value)
	Sets the data of the MIME type. More...

const std::string &	GetContentEncoding () const
	Gets the compressed data from the layer. More...

std::string &	GetMutableContentEncoding ()
	Gets a mutable reference to the compressed data from the layer. More...

void	SetContentEncoding (const std::string &value)
	Sets the compressed data. More...

const Partitioning &	GetPartitioning () const
	Gets the `Partitioning` instance. More...

Partitioning &	GetMutablePartitioning ()
	Gets a mutable reference to the `Partitioning` instance. More...

void	SetPartitioning (const Partitioning &value)
	Sets the `Partitioning` instance. More...

const std::string &	GetLayerType () const
	Gets the type of data availability that this layer provides. More...

std::string &	GetMutableLayerType ()
	Gets a mutable reference to the type of data availability that this layer provides. More...

void	SetLayerType (const std::string &value)
	Sets the data availability type. More...

const std::string &	GetDigest () const
	Gets the digest algorithm used to calculate the checksum for the partitions in this layer. More...

std::string &	GetMutableDigest ()
	Gets a mutable reference to the digest algorithm used to calculate the checksum for the partitions in this layer. More...

void	SetDigest (const std::string &value)
	Sets the digest algorithm used to calculate the checksum for the partitions in this layer. More...

const std::vector< std::string > &	GetTags () const
	Gets the keywords that help to find the layer on the HERE platform Portal. More...

std::vector< std::string > &	GetMutableTags ()
	Gets a mutable reference to the keywords that help to find the layer on the HERE platform Portal. More...

void	SetTags (const std::vector< std::string > &value)
	Sets the keywords that help to find the layer. More...

const std::vector< std::string > &	GetBillingTags () const
	Gets the list of billing tags that are used to group billing records. More...

std::vector< std::string > &	GetMutableBillingTags ()
	Gets a mutable reference to the list of billing tags that are used to group billing records. More...

void	SetBillingTags (const std::vector< std::string > &value)
	Sets the list of billing tags. More...

const boost::optional< int64_t > &	GetTtl () const
	The expiry time (in milliseconds) for data in this layer. More...

boost::optional< int64_t > &	GetMutableTtl ()
	Gets a mutable reference to the expiry time for data in this layer. More...

void	SetTtl (const boost::optional< int64_t > &value)
	Sets the expiry time for data in this layer. More...

const IndexProperties &	GetIndexProperties () const
	Gets the `IndexProperties` instance. More...

IndexProperties &	GetMutableIndexProperties ()
	Gets a mutable reference to the `IndexProperties` instance. More...

void	SetIndexProperties (const IndexProperties &value)
	Sets the `IndexProperties` instance. More...

const StreamProperties &	GetStreamProperties () const
	Gets the `StreamProperties` instance. More...

StreamProperties &	GetMutableStreamProperties ()
	Gets a mutable reference to the `StreamProperties` instance. More...

void	SetStreamProperties (const StreamProperties &value)
	Sets the `StreamProperties` instance. More...

const Volume &	GetVolume () const
	Gets the `Volume` instance. More...

Volume &	GetMutableVolume ()
	Gets a mutable reference to the `Volume` instance. More...

void	SetVolume (const Volume &value)
	Sets the `Volume` instance. More...

Detailed Description

A layer of a catalog.

Member Function Documentation

◆ GetBillingTags()

const std::vector<std::string>& olp::dataservice::read::model::Layer::GetBillingTags ( ) const

inline

Gets the list of billing tags that are used to group billing records.

The billing tag is an optional free-form tag that is used for grouping billing records. If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A-Za-z0-9].

Returns: The list of billing tags.

◆ GetContentEncoding()

const std::string& olp::dataservice::read::model::Layer::GetContentEncoding ( ) const

inline

Gets the compressed data from the layer.

Returns: The compressed data.

◆ GetContentType()

const std::string& olp::dataservice::read::model::Layer::GetContentType ( ) const

inline

Gets the data of the MIME type that is stored in the layer.

Returns: The data of the MIME type.

◆ GetCoverage()

const Coverage& olp::dataservice::read::model::Layer::GetCoverage ( ) const

inline

Gets the Coverage instance.

Returns: The Coverage instance.

◆ GetDescription()

const std::string& olp::dataservice::read::model::Layer::GetDescription ( ) const

inline

Gets the detailed description of the layer.

This information appears on the Overview tab when you open a layer on the HERE platform Portal.

Returns: The detailed description of the layer.

◆ GetDigest()

const std::string& olp::dataservice::read::model::Layer::GetDigest ( ) const

inline

Gets the digest algorithm used to calculate the checksum for the partitions in this layer.

If specified, you can assume that all partitions in the layer, at every version, were calculated using this algorithm.

Note: It is the responsibility of the data publisher to use this algorithm to calculate partition checksums. The HERE platform does not verify that the specified algorithm was actually used.

Returns: The digest algorithm used to calculate the checksum for the partitions in this layer.

◆ GetId()

const std::string& olp::dataservice::read::model::Layer::GetId ( ) const

inline

Gets the ID that is used to refer to this layer programmatically.

Returns: The layer ID.

◆ GetIndexProperties()

const IndexProperties& olp::dataservice::read::model::Layer::GetIndexProperties ( ) const

inline

Gets the IndexProperties instance.

Returns: The IndexProperties instance.

◆ GetLayerType()

const std::string& olp::dataservice::read::model::Layer::GetLayerType ( ) const

inline

Gets the type of data availability that this layer provides.

Returns: The data availability type.

◆ GetMutableBillingTags()

std::vector<std::string>& olp::dataservice::read::model::Layer::GetMutableBillingTags ( )

inline

Gets a mutable reference to the list of billing tags that are used to group billing records.

See also: GetBillingTags for information on the billing tags.

Returns: The mutable reference to the list of billing tags.

◆ GetMutableContentEncoding()

std::string& olp::dataservice::read::model::Layer::GetMutableContentEncoding ( )

inline

Gets a mutable reference to the compressed data from the layer.

Returns: The mutable reference to the compressed data.

◆ GetMutableContentType()

std::string& olp::dataservice::read::model::Layer::GetMutableContentType ( )

inline

Gets a mutable reference to the data of the MIME type that is stored in the layer.

Returns: The mutable reference to the data of the MIME type.

◆ GetMutableCoverage()

Coverage& olp::dataservice::read::model::Layer::GetMutableCoverage ( )

inline

Gets a mutable reference to the Coverage instance.

Returns: The mutable reference to the Coverage instance.

◆ GetMutableDescription()

std::string& olp::dataservice::read::model::Layer::GetMutableDescription ( )

inline

Gets a mutable reference to the detailed description of the layer.

Returns: The mutable reference to the detailed description of the layer.

◆ GetMutableDigest()

std::string& olp::dataservice::read::model::Layer::GetMutableDigest ( )

inline

Gets a mutable reference to the digest algorithm used to calculate the checksum for the partitions in this layer.

See also: GetDigest for information on the digest algorithm.

Returns: The mutable reference to the digest algorithm used to calculate the checksum for the partitions in this layer.

◆ GetMutableId()

std::string& olp::dataservice::read::model::Layer::GetMutableId ( )

inline

Gets a mutable reference to the ID that is used to refer to this layer programmatically.

Returns: The mutable reference to the layer ID.

◆ GetMutableIndexProperties()

IndexProperties& olp::dataservice::read::model::Layer::GetMutableIndexProperties ( )

inline

Gets a mutable reference to the IndexProperties instance.

Returns: The mutable reference to the IndexProperties instance.

◆ GetMutableLayerType()

std::string& olp::dataservice::read::model::Layer::GetMutableLayerType ( )

inline

Gets a mutable reference to the type of data availability that this layer provides.

Returns: The mutable reference to the data availability type.

◆ GetMutableName()

std::string& olp::dataservice::read::model::Layer::GetMutableName ( )

inline

Gets a mutable refrence to the layer display name.

Returns: The mutable reference to the layer display name.

◆ GetMutableOwner()

Owner& olp::dataservice::read::model::Layer::GetMutableOwner ( )

inline

Gets a mutable reference to the Owner instance.

Returns: The mutable reference to the Owner instance.

◆ GetMutablePartitioning()

Partitioning& olp::dataservice::read::model::Layer::GetMutablePartitioning ( )

inline

Gets a mutable reference to the Partitioning instance.

Returns: The mutable reference to the Partitioning instance.

◆ GetMutableSchema()

Schema& olp::dataservice::read::model::Layer::GetMutableSchema ( )

inline

Gets a mutable reference to the Schema instance.

Returns: The mutable reference to the Schema instance.

◆ GetMutableStreamProperties()

StreamProperties& olp::dataservice::read::model::Layer::GetMutableStreamProperties ( )

inline

Gets a mutable reference to the StreamProperties instance.

Returns: The mutable reference to the StreamProperties instance.

◆ GetMutableSummary()

std::string& olp::dataservice::read::model::Layer::GetMutableSummary ( )

inline

Gets a mutable reference to the one-sentence summary of the layer.

See also: GetSummary for information on the layer summary.

Returns: The mutable reference to the one-sentence summary of the layer.

◆ GetMutableTags()

std::vector<std::string>& olp::dataservice::read::model::Layer::GetMutableTags ( )

inline

Gets a mutable reference to the keywords that help to find the layer on the HERE platform Portal.

Returns: The mutable reference to the keywords that help to find the layer.

◆ GetMutableTtl()

boost::optional<int64_t>& olp::dataservice::read::model::Layer::GetMutableTtl ( )

inline

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

See also: GetTtl for information on the expiry time.

Returns: The mutable reference to the expiry time for data in this layer.

◆ GetMutableVolume()

Volume& olp::dataservice::read::model::Layer::GetMutableVolume ( )

inline

Gets a mutable reference to the Volume instance.

Returns: The mutable reference to the Volume instance.

◆ GetName()

const std::string& olp::dataservice::read::model::Layer::GetName ( ) const

inline

Gets the layer display name.

Returns: The layer display name.

◆ GetOwner()

const Owner& olp::dataservice::read::model::Layer::GetOwner ( ) const

inline

Gets the Owner instance.

Returns: The Owner instance.

◆ GetPartitioning()

const Partitioning& olp::dataservice::read::model::Layer::GetPartitioning ( ) const

inline

Gets the Partitioning instance.

Returns: The Partitioning instance.

◆ GetSchema()

const Schema& olp::dataservice::read::model::Layer::GetSchema ( ) const

inline

Gets the Schema instance.

Returns: The Schema instance.

◆ GetStreamProperties()

const StreamProperties& olp::dataservice::read::model::Layer::GetStreamProperties ( ) const

inline

Gets the StreamProperties instance.

Returns: The StreamProperties instance.

◆ GetSummary()

const std::string& olp::dataservice::read::model::Layer::GetSummary ( ) const

inline

Gets the one-sentence summary of the layer.

You can see this summary when you browse a list of layers on the HERE platform Portal.

Returns: The one-sentence summary of the layer.

◆ GetTags()

const std::vector<std::string>& olp::dataservice::read::model::Layer::GetTags ( ) const

inline

Gets the keywords that help to find the layer on the HERE platform Portal.

Returns: The keywords that help to find the layer.

◆ GetTtl()

const boost::optional<int64_t>& olp::dataservice::read::model::Layer::GetTtl ( ) const

inline

The expiry time (in milliseconds) for data in this layer.

Data is automatically removed when the specified time limit elapses. For volatile layers, the TTL value must be between 60000 (1 minute) and 604800000 (7 days). For stream layers, the TTL value must be between 600000 (10 minutes) and 259200000 (72 hours).

Returns: The expiry time (in milliseconds) for data in this layer.

◆ GetVolume()

const Volume& olp::dataservice::read::model::Layer::GetVolume ( ) const

inline

Gets the Volume instance.

Returns: The Volume instance.

◆ SetBillingTags()

void olp::dataservice::read::model::Layer::SetBillingTags ( const std::vector< std::string > & value )

inline

Sets the list of billing tags.

See also: GetBillingTags for information on the billing tags.

Parameters

value The list of billing tags that are used to group billing records.

◆ SetContentEncoding()

void olp::dataservice::read::model::Layer::SetContentEncoding ( const std::string & value )

inline

Sets the compressed data.

Parameters

value The compressed data.

◆ SetContentType()

void olp::dataservice::read::model::Layer::SetContentType ( const std::string & value )

inline

Sets the data of the MIME type.

Parameters

value The data of the MIME type that is stored in the layer.

◆ SetCoverage()

void olp::dataservice::read::model::Layer::SetCoverage ( const Coverage & value )

inline

Sets the Coverage instance.

Parameters

value The Coverage instance.

◆ SetDescription()

void olp::dataservice::read::model::Layer::SetDescription ( const std::string & value )

inline

Sets the detailed description of the layer.

Parameters

value The detailed description of the layer.

◆ SetDigest()

void olp::dataservice::read::model::Layer::SetDigest ( const std::string & value )

inline

Sets the digest algorithm used to calculate the checksum for the partitions in this layer.

See also: GetDigest for information on the digest algorithm.

Parameters

value The digest algorithm used to calculate the checksum for the partitions in this layer.

◆ SetId()

void olp::dataservice::read::model::Layer::SetId ( const std::string & value )

inline

Sets the layer ID.

Parameters

value The layer ID.

◆ SetIndexProperties()

void olp::dataservice::read::model::Layer::SetIndexProperties ( const IndexProperties & value )

inline

Sets the IndexProperties instance.

Parameters

value The IndexProperties instance.

◆ SetLayerType()

void olp::dataservice::read::model::Layer::SetLayerType ( const std::string & value )

inline

Sets the data availability type.

Parameters

value The data availability type.

◆ SetName()

void olp::dataservice::read::model::Layer::SetName ( const std::string & value )

inline

Sets the layer display name.

Parameters

value The layer display name.

◆ SetOwner()

void olp::dataservice::read::model::Layer::SetOwner ( const Owner & value )

inline

Sets the Owner instance.

Parameters

value The Owner instance.

◆ SetPartitioning()

void olp::dataservice::read::model::Layer::SetPartitioning ( const Partitioning & value )

inline

Sets the Partitioning instance.

Parameters

value The Partitioning instance.

◆ SetSchema()

void olp::dataservice::read::model::Layer::SetSchema ( const Schema & value )

inline

Sets the Schema instance.

Parameters

value The Schema instance.

◆ SetStreamProperties()

void olp::dataservice::read::model::Layer::SetStreamProperties ( const StreamProperties & value )

inline

Sets the StreamProperties instance.

Parameters

value The StreamProperties instance

◆ SetSummary()

void olp::dataservice::read::model::Layer::SetSummary ( const std::string & value )

inline

Sets the layer summary.

See also: GetSummary for information on the layer summary.

Parameters

value The one-sentence summary of the layer.

◆ SetTags()

void olp::dataservice::read::model::Layer::SetTags ( const std::vector< std::string > & value )

inline

Sets the keywords that help to find the layer.

Parameters

value The keywords that help to find the layer on the HERE platform Portal.

◆ SetTtl()

void olp::dataservice::read::model::Layer::SetTtl ( const boost::optional< int64_t > & value )

inline

Sets the expiry time for data in this layer.

See also: GetTtl for information on the expiry time.

Parameters

value The expiry time for data in this layer.

◆ SetVolume()

void olp::dataservice::read::model::Layer::SetVolume ( const Volume & value )

inline

Sets the Volume instance.

Parameters

value The Volume instance.

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetBillingTags()

◆ GetContentEncoding()

◆ GetContentType()

◆ GetCoverage()

◆ GetDescription()

◆ GetDigest()

◆ GetId()

◆ GetIndexProperties()

◆ GetLayerType()

◆ GetMutableBillingTags()

◆ GetMutableContentEncoding()

◆ GetMutableContentType()

◆ GetMutableCoverage()

◆ GetMutableDescription()

◆ GetMutableDigest()

◆ GetMutableId()

◆ GetMutableIndexProperties()

◆ GetMutableLayerType()

◆ GetMutableName()

◆ GetMutableOwner()

◆ GetMutablePartitioning()

◆ GetMutableSchema()

◆ GetMutableStreamProperties()

◆ GetMutableSummary()

◆ GetMutableTags()

◆ GetMutableTtl()

◆ GetMutableVolume()

◆ GetName()

◆ GetOwner()

◆ GetPartitioning()

◆ GetSchema()

◆ GetStreamProperties()

◆ GetSummary()

◆ GetTags()

◆ GetTtl()

◆ GetVolume()

◆ SetBillingTags()

◆ SetContentEncoding()

◆ SetContentType()

◆ SetCoverage()

◆ SetDescription()

◆ SetDigest()

◆ SetId()

◆ SetIndexProperties()

◆ SetLayerType()

◆ SetName()

◆ SetOwner()

◆ SetPartitioning()

◆ SetSchema()

◆ SetStreamProperties()

◆ SetSummary()

◆ SetTags()

◆ SetTtl()

◆ SetVolume()