instance_admin_connection.h

Go to the documentation of this file.

// Copyright 2019 Google LLC
//
// 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.

#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_INSTANCE_ADMIN_CONNECTION_H
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_INSTANCE_ADMIN_CONNECTION_H

#include "google/cloud/spanner/backoff_policy.h"
#include "google/cloud/spanner/internal/instance_admin_stub.h"
#include "google/cloud/spanner/polling_policy.h"
#include "google/cloud/spanner/retry_policy.h"
#include "google/cloud/internal/pagination_range.h"
#include <google/spanner/admin/instance/v1/spanner_instance_admin.grpc.pb.h>
#include <map>

namespace google {
namespace cloud {
namespace spanner {
inline namespace SPANNER_CLIENT_NS {

using ListInstancesRange = google::cloud::internal::PaginationRange<
    google::spanner::admin::instance::v1::Instance,
    google::spanner::admin::instance::v1::ListInstancesRequest,
    google::spanner::admin::instance::v1::ListInstancesResponse>;

using ListInstanceConfigsRange = google::cloud::internal::PaginationRange<
    google::spanner::admin::instance::v1::InstanceConfig,
    google::spanner::admin::instance::v1::ListInstanceConfigsRequest,
    google::spanner::admin::instance::v1::ListInstanceConfigsResponse>;

class InstanceAdminConnection {
 public:
  virtual ~InstanceAdminConnection() = 0;


  struct GetInstanceParams {
    std::string instance_name;
  };

  struct CreateInstanceParams {
    google::spanner::admin::instance::v1::CreateInstanceRequest request;
  };

  struct UpdateInstanceParams {
    google::spanner::admin::instance::v1::UpdateInstanceRequest request;
  };

  struct DeleteInstanceParams {
    std::string instance_name;
  };

  struct GetInstanceConfigParams {
    std::string instance_config_name;
  };

  struct ListInstanceConfigsParams {
    std::string project_id;
  };

  struct ListInstancesParams {
    std::string project_id;

    std::string filter;
  };

  struct GetIamPolicyParams {
    std::string instance_name;
  };

  struct SetIamPolicyParams {
    std::string instance_name;
    google::iam::v1::Policy policy;
  };

  struct TestIamPermissionsParams {
    std::string instance_name;
    std::vector<std::string> permissions;
  };

  virtual StatusOr<google::spanner::admin::instance::v1::Instance> GetInstance(
      GetInstanceParams) = 0;

  virtual future<StatusOr<google::spanner::admin::instance::v1::Instance>>
  CreateInstance(CreateInstanceParams p) = 0;

  virtual future<StatusOr<google::spanner::admin::instance::v1::Instance>>
  UpdateInstance(UpdateInstanceParams p) = 0;

  virtual Status DeleteInstance(DeleteInstanceParams p) = 0;

  virtual StatusOr<google::spanner::admin::instance::v1::InstanceConfig>
      GetInstanceConfig(GetInstanceConfigParams) = 0;

  virtual ListInstanceConfigsRange ListInstanceConfigs(
      ListInstanceConfigsParams) = 0;

  virtual ListInstancesRange ListInstances(ListInstancesParams params) = 0;

  virtual StatusOr<google::iam::v1::Policy> GetIamPolicy(
      GetIamPolicyParams) = 0;

  virtual StatusOr<google::iam::v1::Policy> SetIamPolicy(
      SetIamPolicyParams) = 0;

  virtual StatusOr<google::iam::v1::TestIamPermissionsResponse>
      TestIamPermissions(TestIamPermissionsParams) = 0;
};

std::shared_ptr<InstanceAdminConnection> MakeInstanceAdminConnection(
    ConnectionOptions const& options = ConnectionOptions());

std::shared_ptr<InstanceAdminConnection> MakeInstanceAdminConnection(
    ConnectionOptions const& options, std::unique_ptr<RetryPolicy> retry_policy,
    std::unique_ptr<BackoffPolicy> backoff_policy,
    std::unique_ptr<PollingPolicy> polling_policy);

namespace internal {
std::shared_ptr<InstanceAdminConnection> MakeInstanceAdminConnection(
    std::shared_ptr<internal::InstanceAdminStub> base_stub,
    ConnectionOptions const& options);

std::shared_ptr<InstanceAdminConnection> MakeInstanceAdminConnection(
    std::shared_ptr<internal::InstanceAdminStub> base_stub,
    std::unique_ptr<RetryPolicy> retry_policy,
    std::unique_ptr<BackoffPolicy> backoff_policy,
    std::unique_ptr<PollingPolicy> polling_policy);

}  // namespace internal

}  // namespace SPANNER_CLIENT_NS
}  // namespace spanner
}  // namespace cloud
}  // namespace google

#endif  // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_INSTANCE_ADMIN_CONNECTION_H