metadata_update_policy.h

Go to the documentation of this file.

// Copyright 2018 Google 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
//
//     https://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.
 
#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGTABLE_METADATA_UPDATE_POLICY_H
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGTABLE_METADATA_UPDATE_POLICY_H
 
#include "google/cloud/bigtable/version.h"
#include <grpcpp/grpcpp.h>
#include <memory>
#include <string>
#include <utility>
 
namespace google {
namespace cloud {
namespace bigtable {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
/**
 * Define the class for governing x-goog-request-params metadata value.
 *
 * The value of x-goog-request-params starts with one of the following suffix
 *    "parent=" : Operation in instance, e.g. TableAdmin::CreateTable.
 *    "table_name=" : table_id is known at the time of creation, e.g.
 *     Table::Apply.
 *    "name=" : this is used when table|_id is known only in the RPC call, e.g.
 *     TableAdmin::GetTable.
 *     "resource=" : this is used to set IAM policies for bigtable resource.
 *
 * The Setup function also adds x-goog-api-client header for analytics purpose.
 */
class MetadataParamTypes final {
 public:
  // NOLINTNEXTLINE(readability-identifier-naming)
  static MetadataParamTypes const PARENT;
  // NOLINTNEXTLINE(readability-identifier-naming)
  static MetadataParamTypes const NAME;
  // NOLINTNEXTLINE(readability-identifier-naming)
  static MetadataParamTypes const RESOURCE;
  // NOLINTNEXTLINE(readability-identifier-naming)
  static MetadataParamTypes const TABLE_NAME;
  // NOLINTNEXTLINE(readability-identifier-naming)
  static MetadataParamTypes const APP_PROFILE_NAME;
  // NOLINTNEXTLINE(readability-identifier-naming)
  static MetadataParamTypes const INSTANCE_NAME;
  // NOLINTNEXTLINE(readability-identifier-naming)
  static MetadataParamTypes const BACKUP_NAME;
 
  std::string const& type() const { return type_; }
 
 private:
  explicit MetadataParamTypes(std::string type) : type_(std::move(type)) {}
  std::string type_;
};
 
inline bool operator==(MetadataParamTypes const& lhs,
                       MetadataParamTypes const& rhs) {
  return lhs.type() == rhs.type();
}
 
inline bool operator!=(MetadataParamTypes const& lhs,
                       MetadataParamTypes const& rhs) {
  return std::rel_ops::operator!=(lhs, rhs);
}
 
/// MetadataUpdatePolicy holds supported metadata and setup ClientContext
class MetadataUpdatePolicy {
 public:
  /**
   * Constructor with default metadata pair.
   *
   * @param resource_name hierarchical name of resource, including  project id,
   * instance id and/or table_id.
   * @param metadata_param_type type to decide prefix for the value of
   *     x-goog-request-params
   */
  MetadataUpdatePolicy(std::string const& resource_name,
                       MetadataParamTypes const& metadata_param_type);
 
  MetadataUpdatePolicy(MetadataUpdatePolicy&&) = default;
  MetadataUpdatePolicy& operator=(MetadataUpdatePolicy&&) = default;
  MetadataUpdatePolicy(MetadataUpdatePolicy const&) = default;
  MetadataUpdatePolicy& operator=(MetadataUpdatePolicy const&) = default;
 
  // Update the ClientContext for the next call.
  void Setup(grpc::ClientContext& context) const;
 
  std::string const& value() const { return value_; }
  std::string const& api_client_header() const { return api_client_header_; }
 
 private:
  std::string value_;
  std::string api_client_header_;
};
 
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
}  // namespace bigtable
namespace bigtable_internal {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
 
/**
 * Returns a `MetadataUpdatePolicy` that implements the explicit routing
 * specification in `bigtable.proto`.
 */
bigtable::MetadataUpdatePolicy MakeMetadataUpdatePolicy(
    std::string const& table_name, std::string const& app_profile_id);
 
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
}  // namespace bigtable_internal
}  // namespace cloud
}  // namespace google
 
#endif  // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGTABLE_METADATA_UPDATE_POLICY_H