PartitionsRequest.h

/*
 * Copyright (C) 2019-2020 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 <sstream>
#include <string>
#include <utility>
#include <vector>
 
#include <olp/core/porting/optional.h>
#include <olp/dataservice/read/DataServiceReadApi.h>
#include <olp/dataservice/read/FetchOptions.h>
 
namespace olp {
namespace dataservice {
namespace read {
 
class DATASERVICE_READ_API PartitionsRequest final {
 public:
  using PartitionIds = std::vector<std::string>;
 
  static constexpr const char* kDataSize = "dataSize";
 
  static constexpr const char* kChecksum = "checksum";
 
  static constexpr const char* kCompressedDataSize = "compressedDataSize";
 
  static constexpr const char* kCrc = "crc";
 
  using AdditionalFields = std::vector<std::string>;
 
  PartitionsRequest& WithPartitionIds(PartitionIds partition_ids) {
    partition_ids_ = std::move(partition_ids);
    return *this;
  }
 
  const PartitionIds& GetPartitionIds() const { return partition_ids_; }
 
  PartitionsRequest& WithAdditionalFields(AdditionalFields additional_fields) {
    additional_fields_ = std::move(additional_fields);
    return *this;
  }
 
  const AdditionalFields& GetAdditionalFields() const {
    return additional_fields_;
  }
 
  const porting::optional<std::string>& GetBillingTag() const {
    return billing_tag_;
  }
 
  template <class T = porting::optional<std::string>>
  PartitionsRequest& WithBillingTag(T&& billingTag) {
    billing_tag_ = std::forward<T>(billingTag);
    return *this;
  }
 
  FetchOptions GetFetchOption() const { return fetch_option_; }
 
  PartitionsRequest& WithFetchOption(FetchOptions fetch_option) {
    fetch_option_ = fetch_option;
    return *this;
  }
 
  std::string CreateKey(
      const std::string& layer_id,
      porting::optional<int64_t> version = porting::none) const {
    std::stringstream out;
    out << layer_id;
    if (version) {
      out << "@" << *version;
    }
    if (GetBillingTag()) {
      out << "$" << *GetBillingTag();
    }
    out << "^" << GetFetchOption();
    return out.str();
  }
 
 private:
  PartitionIds partition_ids_;
  AdditionalFields additional_fields_;
  porting::optional<std::string> billing_tag_;
  FetchOptions fetch_option_{OnlineIfNotFound};
};
 
}  // namespace read
}  // namespace dataservice
}  // namespace olp