25#include <olp/core/porting/optional.h>
26#include <olp/dataservice/read/DataServiceReadApi.h>
29namespace dataservice {
45 std::vector<std::string> admin_areas_;
57 const std::vector<std::string>&
GetAdminAreas()
const {
return admin_areas_; }
74 this->admin_areas_ = value;
94 int64_t zoomLevel_{0};
102 const std::string&
GetName()
const {
return name_; }
114 void SetName(
const std::string& value) { this->name_ = value; }
121 const std::string&
GetType()
const {
return type_; }
134 void SetType(
const std::string& value) { this->type_ = value; }
165 void SetDuration(
const int64_t& value) { this->duration_ = value; }
201 std::vector<IndexDefinition> index_definitions_;
211 const std::string&
GetTtl()
const {
return ttl_; }
229 void SetTtl(
const std::string& value) { this->ttl_ = value; }
237 return index_definitions_;
245 return index_definitions_;
253 this->index_definitions_ = value;
281 const std::string&
GetId()
const {
return id_; }
297 void SetId(
const std::string& value) { this->id_ = value; }
311 virtual ~Owner() =
default;
376 std::vector<int64_t> tile_levels_;
392 const std::string&
GetScheme()
const {
return scheme_; }
412 void SetScheme(
const std::string& value) { this->scheme_ = value; }
441 this->tile_levels_ = value;
466 const std::string&
GetHrn()
const {
return hrn_; }
478 void SetHrn(
const std::string& value) { this->hrn_ = value; }
494 int64_t data_in_throughput_mbps_{0};
495 int64_t data_out_throughput_mbps_{0};
508 return data_in_throughput_mbps_;
530 this->data_in_throughput_mbps_ = value;
544 return data_out_throughput_mbps_;
557 return data_out_throughput_mbps_;
568 this->data_out_throughput_mbps_ = value;
585 std::string algorithm_;
605 void SetAlgorithm(
const std::string& value) { this->algorithm_ = value; }
621 std::string volume_type_;
622 std::string max_memory_policy_;
623 std::string package_type_;
646 void SetVolumeType(
const std::string& value) { this->volume_type_ = value; }
668 this->max_memory_policy_ = value;
721 virtual ~Layer() =
default;
726 std::string summary_;
727 std::string description_;
731 std::string content_type_;
732 std::string content_encoding_;
734 std::string layer_type_;
736 std::vector<std::string> tags_;
737 std::vector<std::string> billing_tags_;
738 porting::optional<int64_t> ttl_;
749 const std::string&
GetId()
const {
return id_; }
762 void SetId(
const std::string& value) { this->id_ = value; }
769 const std::string&
GetName()
const {
return name_; }
781 void SetName(
const std::string& value) { this->name_ = value; }
807 void SetSummary(
const std::string& value) { this->summary_ = value; }
926 this->content_encoding_ = value;
947 this->partitioning_ = value;
968 void SetLayerType(
const std::string& value) { this->layer_type_ = value; }
984 const std::string&
GetDigest()
const {
return digest_; }
1004 void SetDigest(
const std::string& value) { this->digest_ = value; }
1012 const std::vector<std::string>&
GetTags()
const {
return tags_; }
1026 void SetTags(
const std::vector<std::string>& value) { this->tags_ = value; }
1039 return billing_tags_;
1059 this->billing_tags_ = value;
1072 const porting::optional<int64_t>&
GetTtl()
const {
return ttl_; }
1089 void SetTtl(
const porting::optional<int64_t>& value) { this->ttl_ = value; }
1097 return index_properties_;
1111 this->index_properties_ = value;
1120 return stream_properties_;
1134 this->stream_properties_ = value;
1170 bool enabled_{
false};
1215 std::string summary_;
1216 std::string description_;
1219 std::vector<std::string> tags_;
1220 std::vector<std::string> billing_tags_;
1221 std::string created_;
1222 std::vector<Layer> layers_;
1223 int64_t version_{0};
1238 const std::string&
GetId()
const {
return id_; }
1255 void SetId(
const std::string& value) { this->id_ = value; }
1262 const std::string&
GetHrn()
const {
return hrn_; }
1274 void SetHrn(
const std::string& value) { this->hrn_ = value; }
1281 const std::string&
GetName()
const {
return name_; }
1293 void SetName(
const std::string& value) { this->name_ = value; }
1315 void SetSummary(
const std::string& value) { this->summary_ = value; }
1389 const std::vector<std::string>&
GetTags()
const {
return tags_; }
1404 void SetTags(
const std::vector<std::string>& value) { this->tags_ = value; }
1417 return billing_tags_;
1437 this->billing_tags_ = value;
1457 void SetCreated(
const std::string& value) { this->created_ = value; }
1464 const std::vector<Layer>&
GetLayers()
const {
return layers_; }
1476 void SetLayers(
const std::vector<Layer>& value) { this->layers_ = value; }
1509 void SetVersion(
const int64_t& value) { this->version_ = value; }
1529 this->notifications_ = value;
A model that represents a catalog.
Definition Catalog.h:1202
const Notifications & GetNotifications() const
Gets the Notifications instance.
Definition Catalog.h:1516
Owner & GetMutableOwner()
Gets a mutable reference to the Owner instance.
Definition Catalog.h:1375
Notifications & GetMutableNotifications()
Gets a mutable reference to the Notifications instance.
Definition Catalog.h:1522
const std::string & GetSummary() const
Gets the one-sentence summary of the catalog.
Definition Catalog.h:1303
std::vector< std::string > & GetMutableTags()
Gets a mutable reference to the keywords that help to find the catalog on the HERE platform Portal.
Definition Catalog.h:1397
void SetNotifications(const Notifications &value)
Sets the Notifications instance.
Definition Catalog.h:1528
const Owner & GetOwner() const
Gets the Owner instance.
Definition Catalog.h:1369
void SetCreated(const std::string &value)
Sets the catalog creation date and time.
Definition Catalog.h:1457
const std::vector< std::string > & GetTags() const
Gets the keywords that help to find the catalog on the HERE platform Portal.
Definition Catalog.h:1389
void SetLayers(const std::vector< Layer > &value)
Sets the vector with the Layer instance.
Definition Catalog.h:1476
void SetVersion(const int64_t &value)
Sets the catalog configuration version.
Definition Catalog.h:1509
std::vector< Layer > & GetMutableLayers()
Gets a mutable reference to the vector with the Layer instance.
Definition Catalog.h:1470
const Coverage & GetCoverage() const
Gets the Coverage instance.
Definition Catalog.h:1350
const std::string & GetDescription() const
Gets the detailed description of the catalog.
Definition Catalog.h:1325
void SetBillingTags(const std::vector< std::string > &value)
Sets the list of billing tags.
Definition Catalog.h:1436
std::string & GetMutableName()
Gets a mutable reference to the catalog short name.
Definition Catalog.h:1287
Coverage & GetMutableCoverage()
Gets a mutable reference to the Coverage instance.
Definition Catalog.h:1356
std::string & GetMutableId()
Gets a mutable reference to the ID that is used to refer to this catalog programmatically.
Definition Catalog.h:1247
void SetOwner(const Owner &value)
Sets the Owner instance.
Definition Catalog.h:1381
void SetSummary(const std::string &value)
Sets the catalog summary.
Definition Catalog.h:1315
const std::vector< Layer > & GetLayers() const
Gets the vector with the Layer instance.
Definition Catalog.h:1464
const std::string & GetHrn() const
Gets the HERE Resource Name (HRN) of the catalog.
Definition Catalog.h:1262
void SetCoverage(const Coverage &value)
Sets the Coverage instance.
Definition Catalog.h:1362
void SetHrn(const std::string &value)
Sets the catalog HRN.
Definition Catalog.h:1274
std::string & GetMutableDescription()
Gets a mutable reference to the detailed description of the catalog.
Definition Catalog.h:1334
const std::vector< std::string > & GetBillingTags() const
Gets the list of billing tags that are used to group billing records.
Definition Catalog.h:1416
std::string & GetMutableCreated()
Gets a mutable reference to the catalog creation date and time.
Definition Catalog.h:1451
const std::string & GetName() const
Gets the short name of the catalog.
Definition Catalog.h:1281
void SetDescription(const std::string &value)
Sets the detailed description of the catalog.
Definition Catalog.h:1343
int64_t & GetMutableVersion()
Gets a mutable reference to the version of the catalog configuration.
Definition Catalog.h:1500
const std::string & GetCreated() const
Gets the catalog creation date and time.
Definition Catalog.h:1445
void SetName(const std::string &value)
Sets the catalog short name.
Definition Catalog.h:1293
void SetId(const std::string &value)
Sets the catalog ID.
Definition Catalog.h:1255
std::string & GetMutableSummary()
Gets a mutable reference to the one-sentence summary of the catalog.
Definition Catalog.h:1309
std::string & GetMutableHrn()
Gets a mutable reference to the HRN of the catalog.
Definition Catalog.h:1268
const std::string & GetId() const
Gets the ID that is used to refer to this catalog programmatically.
Definition Catalog.h:1238
void SetTags(const std::vector< std::string > &value)
Sets the keywords that help to find the catalog.
Definition Catalog.h:1404
std::vector< std::string > & GetMutableBillingTags()
Gets a mutable reference to the list of billing tags that are used to group billing records.
Definition Catalog.h:1427
const int64_t & GetVersion() const
Gets the version of the catalog configuration.
Definition Catalog.h:1490
Geographic areas that the catalog covers.
Definition Catalog.h:35
const std::vector< std::string > & GetAdminAreas() const
Gets the string of catalog administrative areas.
Definition Catalog.h:57
std::vector< std::string > & GetMutableAdminAreas()
Gets a mutable reference to the catalog administrative areas.
Definition Catalog.h:65
void SetAdminAreas(const std::vector< std::string > &value)
Sets the catalog administrative areas.
Definition Catalog.h:73
Contains information on a user or application that initially created the catalog.
Definition Catalog.h:261
const std::string & GetId() const
Gets the unique ID of the user or application that initially created the catalog.
Definition Catalog.h:281
std::string & GetMutableId()
Gets a mutable reference to the ID of the user or application that initially created the catalog.
Definition Catalog.h:289
void SetId(const std::string &value)
Sets the ID of the user or application that initially created the catalog.
Definition Catalog.h:297
An encryption scheme of the catalog.
Definition Catalog.h:575
std::string & GetMutableAlgorithm()
Gets a mutable reference to the encryption algorithm.
Definition Catalog.h:599
const std::string & GetAlgorithm() const
Gets the encryption algorithm.
Definition Catalog.h:593
void SetAlgorithm(const std::string &value)
Sets the encryption algorithm.
Definition Catalog.h:605
A model that represents a definition of an index field.
Definition Catalog.h:81
const std::string & GetType() const
Gets the type of data availability that this layer provides.
Definition Catalog.h:121
void SetDuration(const int64_t &value)
Sets the duration of the time window.
Definition Catalog.h:165
int64_t & GetMutableZoomLevel()
Gets a mutable reference to the tile size.
Definition Catalog.h:178
const int64_t & GetDuration() const
Gets the duration of the time window in milliseconds.
Definition Catalog.h:145
std::string & GetMutableName()
Gets a mutable reference to the short name of the index field.
Definition Catalog.h:108
const int64_t & GetZoomLevel() const
Gets the tile size.
Definition Catalog.h:172
void SetType(const std::string &value)
Sets the data availability type.
Definition Catalog.h:134
void SetZoomLevel(const int64_t &value)
Sets the tile size.
Definition Catalog.h:184
std::string & GetMutableType()
Gets a mutable reference to the type of data availability that this layer provides.
Definition Catalog.h:128
const std::string & GetName() const
Gets the short name of the index field.
Definition Catalog.h:102
int64_t & GetMutableDuration()
Gets a mutable reference to the duration of the time window in milliseconds.
Definition Catalog.h:156
void SetName(const std::string &value)
Sets the short name of the index field.
Definition Catalog.h:114
A model that represents index properties.
Definition Catalog.h:190
std::vector< IndexDefinition > & GetMutableIndexDefinitions()
Gets a mutable reference to the IndexDefinition instance.
Definition Catalog.h:244
const std::vector< IndexDefinition > & GetIndexDefinitions() const
Gets the IndexDefinition instance.
Definition Catalog.h:236
void SetIndexDefinitions(const std::vector< IndexDefinition > &value)
Sets the IndexDefinition instance.
Definition Catalog.h:252
std::string & GetMutableTtl()
Gets a mutable reference to the expiry time for data in the index layer.
Definition Catalog.h:221
void SetTtl(const std::string &value)
Sets the expiry time for the data in the index layer.
Definition Catalog.h:229
const std::string & GetTtl() const
Gets the expiry time (in milliseconds) for data in the index layer.
Definition Catalog.h:211
A layer of a catalog.
Definition Catalog.h:714
const std::string & GetName() const
Gets the layer display name.
Definition Catalog.h:769
const std::string & GetDescription() const
Gets the detailed description of the layer.
Definition Catalog.h:817
const StreamProperties & GetStreamProperties() const
Gets the StreamProperties instance.
Definition Catalog.h:1119
std::vector< std::string > & GetMutableTags()
Gets a mutable reference to the keywords that help to find the layer on the HERE platform Portal.
Definition Catalog.h:1019
void SetLayerType(const std::string &value)
Sets the data availability type.
Definition Catalog.h:968
void SetDescription(const std::string &value)
Sets the detailed description of the layer.
Definition Catalog.h:829
porting::optional< int64_t > & GetMutableTtl()
Gets a mutable reference to the expiry time for data in this layer.
Definition Catalog.h:1081
std::string & GetMutableDescription()
Gets a mutable reference to the detailed description of the layer.
Definition Catalog.h:823
void SetId(const std::string &value)
Sets the layer ID.
Definition Catalog.h:762
const Volume & GetVolume() const
Gets the Volume instance.
Definition Catalog.h:1142
const std::string & GetContentEncoding() const
Gets the compressed data from the layer.
Definition Catalog.h:913
const std::vector< std::string > & GetBillingTags() const
Gets the list of billing tags that are used to group billing records.
Definition Catalog.h:1038
void SetTtl(const porting::optional< int64_t > &value)
Sets the expiry time for data in this layer.
Definition Catalog.h:1089
std::vector< std::string > & GetMutableBillingTags()
Gets a mutable reference to the list of billing tags that are used to group billing records.
Definition Catalog.h:1049
const std::string & GetSummary() const
Gets the one-sentence summary of the layer.
Definition Catalog.h:791
void SetContentType(const std::string &value)
Sets the data of the MIME type.
Definition Catalog.h:906
const std::string & GetDigest() const
Gets the digest algorithm used to calculate the checksum for the partitions in this layer.
Definition Catalog.h:984
std::string & GetMutableLayerType()
Gets a mutable reference to the type of data availability that this layer provides.
Definition Catalog.h:962
std::string & GetMutableDigest()
Gets a mutable reference to the digest algorithm used to calculate the checksum for the partitions in...
Definition Catalog.h:994
Volume & GetMutableVolume()
Gets a mutable reference to the Volume instance.
Definition Catalog.h:1148
Partitioning & GetMutablePartitioning()
Gets a mutable reference to the Partitioning instance.
Definition Catalog.h:940
IndexProperties & GetMutableIndexProperties()
Gets a mutable reference to the IndexProperties instance.
Definition Catalog.h:1104
StreamProperties & GetMutableStreamProperties()
Gets a mutable reference to the StreamProperties instance.
Definition Catalog.h:1127
void SetDigest(const std::string &value)
Sets the digest algorithm used to calculate the checksum for the partitions in this layer.
Definition Catalog.h:1004
void SetCoverage(const Coverage &value)
Sets the Coverage instance.
Definition Catalog.h:867
const IndexProperties & GetIndexProperties() const
Gets the IndexProperties instance.
Definition Catalog.h:1096
Coverage & GetMutableCoverage()
Gets a mutable reference to the Coverage instance.
Definition Catalog.h:861
void SetContentEncoding(const std::string &value)
Sets the compressed data.
Definition Catalog.h:925
std::string & GetMutableId()
Gets a mutable reference to the ID that is used to refer to this layer programmatically.
Definition Catalog.h:756
std::string & GetMutableSummary()
Gets a mutable reference to the one-sentence summary of the layer.
Definition Catalog.h:799
Owner & GetMutableOwner()
Gets a mutable reference to the Owner instance.
Definition Catalog.h:842
void SetTags(const std::vector< std::string > &value)
Sets the keywords that help to find the layer.
Definition Catalog.h:1026
std::string & GetMutableContentType()
Gets a mutable reference to the data of the MIME type that is stored in the layer.
Definition Catalog.h:900
const Partitioning & GetPartitioning() const
Gets the Partitioning instance.
Definition Catalog.h:934
const std::string & GetId() const
Gets the ID that is used to refer to this layer programmatically.
Definition Catalog.h:749
const Schema & GetSchema() const
Gets the Schema instance.
Definition Catalog.h:874
const Coverage & GetCoverage() const
Gets the Coverage instance.
Definition Catalog.h:855
void SetIndexProperties(const IndexProperties &value)
Sets the IndexProperties instance.
Definition Catalog.h:1110
const std::vector< std::string > & GetTags() const
Gets the keywords that help to find the layer on the HERE platform Portal.
Definition Catalog.h:1012
void SetBillingTags(const std::vector< std::string > &value)
Sets the list of billing tags.
Definition Catalog.h:1058
void SetName(const std::string &value)
Sets the layer display name.
Definition Catalog.h:781
std::string & GetMutableContentEncoding()
Gets a mutable reference to the compressed data from the layer.
Definition Catalog.h:919
const std::string & GetContentType() const
Gets the data of the MIME type that is stored in the layer.
Definition Catalog.h:893
const porting::optional< int64_t > & GetTtl() const
The expiry time (in milliseconds) for data in this layer.
Definition Catalog.h:1072
void SetPartitioning(const Partitioning &value)
Sets the Partitioning instance.
Definition Catalog.h:946
Schema & GetMutableSchema()
Gets a mutable reference to the Schema instance.
Definition Catalog.h:880
std::string & GetMutableName()
Gets a mutable refrence to the layer display name.
Definition Catalog.h:775
void SetStreamProperties(const StreamProperties &value)
Sets the StreamProperties instance.
Definition Catalog.h:1133
void SetOwner(const Owner &value)
Sets the Owner instance.
Definition Catalog.h:848
const std::string & GetLayerType() const
Gets the type of data availability that this layer provides.
Definition Catalog.h:955
const Owner & GetOwner() const
Gets the Owner instance.
Definition Catalog.h:836
void SetSchema(const Schema &value)
Sets the Schema instance.
Definition Catalog.h:886
void SetSummary(const std::string &value)
Sets the layer summary.
Definition Catalog.h:807
void SetVolume(const Volume &value)
Sets the Volume instance.
Definition Catalog.h:1154
Catalog notifications.
Definition Catalog.h:1160
void SetEnabled(const bool &value)
Sets the notifications for the catalog.
Definition Catalog.h:1196
const bool & GetEnabled() const
Checks whether the notifications are written to the notification stream each time the catalog version...
Definition Catalog.h:1180
bool & GetMutableEnabled()
Checks whether the notifications are written to the notification stream each time the catalog version...
Definition Catalog.h:1189
Contains information on the catalog creator and customer organisation that is related to the catalog.
Definition Catalog.h:304
const Creator & GetCreator() const
Gets the Creator instance.
Definition Catalog.h:323
const Creator & GetOrganisation() const
Gets the ID of the customer organisation that is related to this catalog.
Definition Catalog.h:344
void SetCreator(const Creator &value)
Sets Creator instance.
Definition Catalog.h:335
void SetOrganisation(const Creator &value)
Sets ID of the customer organisation.
Definition Catalog.h:359
Creator & GetMutableOrganisation()
Gets a mutable reference to the ID of the customer organisation that is related to this catalog.
Definition Catalog.h:352
Creator & GetMutableCreator()
Gets a mutable reference to the Creator instance.
Definition Catalog.h:329
A paritioning scheme of the catalog.
Definition Catalog.h:365
void SetScheme(const std::string &value)
Sets the name of the catalog partitioning scheme.
Definition Catalog.h:412
std::vector< int64_t > & GetMutableTileLevels()
Gets a mutable reference to the list of the quad tree tile levels that contain data partitions.
Definition Catalog.h:432
std::string & GetMutableScheme()
Gets a mutable reference to the name of the catalog partitioning scheme.
Definition Catalog.h:403
const std::vector< int64_t > & GetTileLevels() const
Gets the list of the quad tree tile levels that contain data partitions.
Definition Catalog.h:422
const std::string & GetScheme() const
Gets the name of the catalog partitioning scheme.
Definition Catalog.h:392
void SetTileLevels(const std::vector< int64_t > &value)
Sets the list of the quadtree tile levels that contain data partitions.
Definition Catalog.h:440
Describes a HERE Resource Name (HRN) of a layer schema.
Definition Catalog.h:448
const std::string & GetHrn() const
Gets the HRN of the layer schema.
Definition Catalog.h:466
void SetHrn(const std::string &value)
Sets the HRN of the layer schema.
Definition Catalog.h:478
std::string & GetMutableHrn()
Gets a mutable reference to the HRN of the layer schema.
Definition Catalog.h:472
Properties that define the scale of the required streaming service.
Definition Catalog.h:484
void SetDataInThroughputMbps(const int64_t &value)
Sets the maximum throughput for the incoming data.
Definition Catalog.h:529
void SetDataOutThroughputMbps(const int64_t &value)
Sets the maximum throughput for the outgoing data.
Definition Catalog.h:567
int64_t & GetMutableDataInThroughputMbps()
Gets a mutable reference to the maximum throughput for the incoming data.
Definition Catalog.h:520
const int64_t & GetDataOutThroughputMbps() const
Gets the maximum throughput for the outgoing data expressed in megabytes per second.
Definition Catalog.h:543
int64_t & GetMutableDataOutThroughputMbps()
Gets a mutable reference to the maximum throughput for the outgoing data.
Definition Catalog.h:556
const int64_t & GetDataInThroughputMbps() const
Gets the maximum throughput for the incoming data expressed in megabytes per second.
Definition Catalog.h:507
Describes storage details of a catalog layer.
Definition Catalog.h:611
void SetMaxMemoryPolicy(const std::string &value)
Sets the keys eviction policy.
Definition Catalog.h:667
const std::string & GetVolumeType() const
Gets the volume type that is used to store the layer data content.
Definition Catalog.h:632
void SetEncryption(const Encryption &value)
Sets the Encryption instance.
Definition Catalog.h:708
const std::string & GetPackageType() const
Gets the initial package type (capacity) of the layer.
Definition Catalog.h:676
std::string & GetMutablePackageType()
Gets a mutable reference to the package type (capacity) of the layer.
Definition Catalog.h:683
void SetVolumeType(const std::string &value)
Sets the volume type.
Definition Catalog.h:646
std::string & GetMutableVolumeType()
Gets a mutable reference to the volume type that is used to store the layer data content.
Definition Catalog.h:640
std::string & GetMutableMaxMemoryPolicy()
Gets a mutable reference to the keys eviction policy when the memory limit for the layer is reached.
Definition Catalog.h:661
void SetPackageType(const std::string &value)
Sets the package type (capacity) of the layer.
Definition Catalog.h:689
const std::string & GetMaxMemoryPolicy() const
Gets the keys eviction policy when the memory limit for the layer is reached.
Definition Catalog.h:654
Encryption & GetMutableEncryption()
Gets a mutable reference to the Encryption instance.
Definition Catalog.h:702
const Encryption & GetEncryption() const
Gets the Encryption instance.
Definition Catalog.h:696
Rules all the other namespaces.
Definition AppleSignInProperties.h:24