Add classes for comptabile versions request. (#1299)

Add classes for future API for comtabile
versions request.

Resolves: OAM-1338

Signed-off-by: Serhii Lozynskyi <[email protected]>

Author: meravingen123

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/CatalogClient.h

@@ -27,6 +27,7 @@
 #include <olp/core/porting/deprecated.h>
 #include <olp/dataservice/read/CatalogRequest.h>
 #include <olp/dataservice/read/CatalogVersionRequest.h>
+#include <olp/dataservice/read/CompatibleVersionsRequest.h>
 #include <olp/dataservice/read/DataRequest.h>
 #include <olp/dataservice/read/DataServiceReadApi.h>
 #include <olp/dataservice/read/PartitionsRequest.h>

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/CompatibleVersionsRequest.h

@@ -0,0 +1,90 @@
+/*
+ * Copyright (C) 2022 HERE Europe B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+#pragma once
+
+#include <olp/dataservice/read/DataServiceReadApi.h>
+#include <olp/dataservice/read/model/CatalogVersion.h>
+
+#include <utility>
+#include <vector>
+
+namespace olp {
+namespace dataservice {
+namespace read {
+
+/**
+ * @brief Contains fields required to request compatible versions for
+ * the given catalog.
+ */
+class DATASERVICE_READ_API CompatibleVersionsRequest final {
+ public:
+  using Dependencies = std::vector<model::CatalogVersion>;
+
+  /**
+   * @brief Gets the dependencies for the catalog versions compatibility check.
+   *
+   * @return The dependencies for the catalog versions compatibility check.
+   */
+  inline const Dependencies& GetDependencies() const { return dependencies_; }
+
+  /**
+   * @brief Sets the dependencies to check the catalog versions for
+   * compatibility.
+   *
+   * @param dependencies The dependencies for the catalog versions
+   * compatibility check.
+   *
+   * @return A reference to the updated `CompatibleVersionsRequest` instance.
+   */
+  inline CompatibleVersionsRequest& WithDependencies(
+      Dependencies dependencies) {
+    dependencies_ = std::move(dependencies);
+    return *this;
+  }
+
+  /**
+   * @brief Gets the maximum amount of versions available in the response.
+   *
+   * @return The maximum amount of versions available in the response.
+   */
+  inline int32_t GetLimit() const { return limit_; }
+
+  /**
+   * @brief Sets the maximum amount of versions available in the
+   * response.
+   *
+   * @param limit The maximum amount of versions available in the
+   * response. The default limit is 1.
+   *
+   * @return A reference to the updated `CompatibleVersionsRequest` instance.
+   */
+  inline CompatibleVersionsRequest& WithLimit(int32_t limit) {
+    limit_ = limit;
+    return *this;
+  }
+
+ private:
+  Dependencies dependencies_;
+  int32_t limit_{1};
+};
+
+}  // namespace read
+}  // namespace dataservice
+}  // namespace olp

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/Types.h

@@ -36,6 +36,7 @@
 #include <olp/dataservice/read/model/Partitions.h>
 #include <olp/dataservice/read/model/VersionInfos.h>
 #include <olp/dataservice/read/model/VersionResponse.h>
+#include <olp/dataservice/read/model/VersionsResponse.h>
 
 namespace olp {
 namespace dataservice {

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

@@ -0,0 +1,71 @@
+/*
+ * Copyright (C) 2022 HERE Europe B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+#pragma once
+
+#include <string>
+#include <utility>
+
+#include <olp/dataservice/read/DataServiceReadApi.h>
+
+namespace olp {
+namespace dataservice {
+namespace read {
+namespace model {
+
+/// Represents catalog with the version.
+class DATASERVICE_READ_API CatalogVersion final {
+ public:
+  /**
+   * @brief Gets the HRN of the catalog.
+   *
+   * @return The HRN of the catalog.
+   */
+  const std::string& GetHrn() const { return hrn_; }
+
+  /**
+   * @brief Sets the HRN of the catalog.
+   *
+   * @param hrn The HRN of the catalog.
+   */
+  void SetHrn(std::string hrn) { hrn_ = std::move(hrn); }
+
+  /**
+   * @brief Gets the version of the catalog.
+   *
+   * @return The version of the catalog.
+   */
+  int64_t GetVersion() const { return version_; }
+
+  /**
+   * @brief Sets the version of the dependent catalog.
+   *
+   * @param version The version of the catalog.
+   */
+  void SetVersion(int64_t version) { version_ = version; }
+
+ private:
+  std::string hrn_;
+  int64_t version_{0};
+};
+
+}  // namespace model
+}  // namespace read
+}  // namespace dataservice
+}  // namespace olp

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

@@ -0,0 +1,67 @@
+/*
+ * Copyright (C) 2022 HERE Europe B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+#pragma once
+
+#include <utility>
+#include <vector>
+
+#include <olp/dataservice/read/DataServiceReadApi.h>
+#include <olp/dataservice/read/model/VersionsResponseEntry.h>
+
+namespace olp {
+namespace dataservice {
+namespace read {
+namespace model {
+
+/// Represents a result of the compatible versions request.
+class DATASERVICE_READ_API VersionsResponse final {
+ public:
+  using VersionsResponseEntries = std::vector<VersionsResponseEntry>;
+
+  /**
+   * @brief Sets the information on the compatible versions.
+   *
+   * It contains the version numbers and dependencies for the requested catalog.
+   *
+   * @param entries The information on the compatible versions.
+   */
+  void SetVersionResponseEntries(VersionsResponseEntries entries) {
+    entries_ = std::move(entries);
+  }
+
+  /**
+   * @brief Gets the information on the compatible versions.
+   *
+   * It contains the version numbers and dependencies for the requested catalog.
+   *
+   * @return The information on the compatible versions.
+   */
+  const VersionsResponseEntries& GetVersionResponseEntries() const {
+    return entries_;
+  }
+
+ private:
+  VersionsResponseEntries entries_;
+};
+
+}  // namespace model
+}  // namespace read
+}  // namespace dataservice
+}  // namespace olp

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

@@ -0,0 +1,78 @@
+/*
+ * Copyright (C) 2022 HERE Europe B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+#pragma once
+
+#include <utility>
+#include <vector>
+
+#include <olp/dataservice/read/DataServiceReadApi.h>
+#include <olp/dataservice/read/model/CatalogVersion.h>
+
+namespace olp {
+namespace dataservice {
+namespace read {
+namespace model {
+
+/// Represents dependencies for the given catalog version.
+class DATASERVICE_READ_API VersionsResponseEntry {
+ public:
+  using CatalogVersions = std::vector<CatalogVersion>;
+
+  /**
+   * @brief Sets the information on the dependencies.
+   *
+   * @param catalog_versions The information of the dependencies.
+   */
+  void SetCatalogVersions(CatalogVersions catalog_versions) {
+    catalog_versions_ = std::move(catalog_versions);
+  }
+
+  /**
+   * @brief Gets the information on the compatible versions.
+   *
+   * @return The information on the compatible versions.
+   */
+  const CatalogVersions& GetCatalogVersions() const {
+    return catalog_versions_;
+  }
+
+  /**
+   * @brief Gets the version of the catalog.
+   *
+   * @return The version of the catalog.
+   */
+  int64_t GetVersion() const { return version_; }
+
+  /**
+   * @brief Sets the version of the catalog.
+   *
+   * @param version The version of the catalog.
+   */
+  void SetVersion(int64_t version) { version_ = version; }
+
+ private:
+  int64_t version_{0};
+  CatalogVersions catalog_versions_;
+};
+
+}  // namespace model
+}  // namespace read
+}  // namespace dataservice
+}  // namespace olp