analytics_link.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *   Copyright 2023-present Couchbase, Inc.
 *
 *   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.
 */
 
#pragma once
 
#include <optional>
#include <string>
 
namespace couchbase::management
{
 
enum analytics_link_type {
  s3_external,
 
  azure_external,
 
  couchbase_remote,
};
 
enum analytics_encryption_level {
  none,
 
  half,
 
  full
};
 
struct analytics_link {
  std::string name;
  std::string dataverse_name;
 
  virtual ~analytics_link() = default;
 
  [[nodiscard]] virtual auto link_type() const -> analytics_link_type = 0;
 
  analytics_link() = default;
  analytics_link(std::string name, std::string dataverse_name);
};
 
struct couchbase_analytics_encryption_settings {
  analytics_encryption_level encryption_level{ analytics_encryption_level::none };
 
  std::optional<std::string> certificate{};
 
  std::optional<std::string> client_certificate{};
 
  std::optional<std::string> client_key{};
};
 
struct couchbase_remote_analytics_link : analytics_link {
  std::string hostname;
  couchbase_analytics_encryption_settings encryption{};
  std::optional<std::string> username{};
  std::optional<std::string> password{};
 
  [[nodiscard]] auto link_type() const -> analytics_link_type override
  {
    return analytics_link_type::couchbase_remote;
  }
 
  couchbase_remote_analytics_link() = default;
 
  couchbase_remote_analytics_link(std::string name,
                                  std::string dataverse_name,
                                  std::string hostname,
                                  couchbase_analytics_encryption_settings encryption = {},
                                  std::optional<std::string> username = {},
                                  std::optional<std::string> password = {});
};
 
struct s3_external_analytics_link : analytics_link {
  std::string access_key_id;
  std::string secret_access_key;
  std::string region;
  std::optional<std::string> session_token{};
  std::optional<std::string> service_endpoint{};
 
  [[nodiscard]] auto link_type() const -> analytics_link_type override
  {
    return analytics_link_type::s3_external;
  }
 
  s3_external_analytics_link() = default;
 
  s3_external_analytics_link(std::string name,
                             std::string dataverse_name,
                             std::string access_key_id,
                             std::string secret_access_key,
                             std::string region,
                             std::optional<std::string> session_token = {},
                             std::optional<std::string> service_endpoint = {});
};
 
struct azure_blob_external_analytics_link : analytics_link {
  std::optional<std::string> connection_string{};
  std::optional<std::string> account_name{};
  std::optional<std::string> account_key{};
  std::optional<std::string> shared_access_signature{};
  std::optional<std::string> blob_endpoint{};
  std::optional<std::string> endpoint_suffix{};
 
  [[nodiscard]] auto link_type() const -> analytics_link_type override
  {
    return analytics_link_type::azure_external;
  }
 
  azure_blob_external_analytics_link() = default;
 
  azure_blob_external_analytics_link(std::string name,
                                     std::string dataverse_name,
                                     std::optional<std::string> connection_string = {},
                                     std::optional<std::string> account_name = {},
                                     std::optional<std::string> account_key = {},
                                     std::optional<std::string> shared_access_signature = {},
                                     std::optional<std::string> blob_endpoint = {},
                                     std::optional<std::string> endpoint_suffix = {});
};
 
} // namespace couchbase::management