bigtable_instance_admin_client.h

// Copyright 2021 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
//
//      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.

// Generated by the Codegen C++ plugin.
// If you make any local changes, they will be lost.
// source: google/bigtable/admin/v2/bigtable_instance_admin.proto

#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGTABLE_ADMIN_BIGTABLE_INSTANCE_ADMIN_CLIENT_H
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGTABLE_ADMIN_BIGTABLE_INSTANCE_ADMIN_CLIENT_H

#include "google/cloud/bigtable/admin/bigtable_instance_admin_connection.h"
#include "google/cloud/future.h"
#include "google/cloud/iam_updater.h"
#include "google/cloud/options.h"
#include "google/cloud/polling_policy.h"
#include "google/cloud/status_or.h"
#include "google/cloud/version.h"
#include <google/longrunning/operations.grpc.pb.h>
#include <map>
#include <memory>

namespace google {
namespace cloud {
namespace bigtable_admin {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN

///
/// Service for creating, configuring, and deleting Cloud Bigtable Instances and
/// Clusters. Provides access to the Instance and Cluster schemas only, not the
/// tables' metadata or data stored in those tables.
///
/// @par Equality
///
/// Instances of this class created via copy-construction or copy-assignment
/// always compare equal. Instances created with equal
/// `std::shared_ptr<*Connection>` objects compare equal. Objects that compare
/// equal share the same underlying resources.
///
/// @par Performance
///
/// Creating a new instance of this class is a relatively expensive operation,
/// new objects establish new connections to the service. In contrast,
/// copy-construction, move-construction, and the corresponding assignment
/// operations are relatively efficient as the copies share all underlying
/// resources.
///
/// @par Thread Safety
///
/// Concurrent access to different instances of this class, even if they compare
/// equal, is guaranteed to work. Two or more threads operating on the same
/// instance of this class is not guaranteed to work. Since copy-construction
/// and move-construction is a relatively efficient operation, consider using
/// such a copy when using this class from multiple threads.
///
class BigtableInstanceAdminClient {
 public:
  explicit BigtableInstanceAdminClient(
      std::shared_ptr<BigtableInstanceAdminConnection> connection,
      Options opts = {});
  ~BigtableInstanceAdminClient();

  ///@{
  /// @name Copy and move support
  BigtableInstanceAdminClient(BigtableInstanceAdminClient const&) = default;
  BigtableInstanceAdminClient& operator=(BigtableInstanceAdminClient const&) =
      default;
  BigtableInstanceAdminClient(BigtableInstanceAdminClient&&) = default;
  BigtableInstanceAdminClient& operator=(BigtableInstanceAdminClient&&) =
      default;
  ///@}

  ///@{
  /// @name Equality
  friend bool operator==(BigtableInstanceAdminClient const& a,
                         BigtableInstanceAdminClient const& b) {
    return a.connection_ == b.connection_;
  }
  friend bool operator!=(BigtableInstanceAdminClient const& a,
                         BigtableInstanceAdminClient const& b) {
    return !(a == b);
  }
  ///@}

  ///
  /// Create an instance within a project.
  ///
  /// Note that exactly one of Cluster.serve_nodes and
  /// Cluster.cluster_config.cluster_autoscaling_config can be set. If
  /// serve_nodes is set to non-zero, then the cluster is manually scaled. If
  /// cluster_config.cluster_autoscaling_config is non-empty, then autoscaling
  /// is enabled.
  ///
  /// @param parent  Required. The unique name of the project in which to create
  /// the new instance.
  ///  Values are of the form `projects/{project}`.
  /// @param instance_id  Required. The ID to be used when referring to the new
  /// instance within its project,
  ///  e.g., just `myinstance` rather than
  ///  `projects/myproject/instances/myinstance`.
  /// @param instance  Required. The instance to create.
  ///  Fields marked `OutputOnly` must be left blank.
  /// @param clusters  Required. The clusters to be created within the instance,
  /// mapped by desired
  ///  cluster ID, e.g., just `mycluster` rather than
  ///  `projects/myproject/instances/myinstance/clusters/mycluster`.
  ///  Fields marked `OutputOnly` must be left blank.
  ///  Currently, at most four clusters can be specified.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Instance,google/bigtable/admin/v2/instance.proto#L40}
  ///
  /// [google.bigtable.admin.v2.CreateInstanceRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L289}
  /// [google.bigtable.admin.v2.Instance]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L40}
  ///
  future<StatusOr<google::bigtable::admin::v2::Instance>> CreateInstance(
      std::string const& parent, std::string const& instance_id,
      google::bigtable::admin::v2::Instance const& instance,
      std::map<std::string, google::bigtable::admin::v2::Cluster> const&
          clusters,
      Options opts = {});

  ///
  /// Create an instance within a project.
  ///
  /// Note that exactly one of Cluster.serve_nodes and
  /// Cluster.cluster_config.cluster_autoscaling_config can be set. If
  /// serve_nodes is set to non-zero, then the cluster is manually scaled. If
  /// cluster_config.cluster_autoscaling_config is non-empty, then autoscaling
  /// is enabled.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::CreateInstanceRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L289}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Instance,google/bigtable/admin/v2/instance.proto#L40}
  ///
  /// [google.bigtable.admin.v2.CreateInstanceRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L289}
  /// [google.bigtable.admin.v2.Instance]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L40}
  ///
  future<StatusOr<google::bigtable::admin::v2::Instance>> CreateInstance(
      google::bigtable::admin::v2::CreateInstanceRequest const& request,
      Options opts = {});

  ///
  /// Gets information about an instance.
  ///
  /// @param name  Required. The unique name of the requested instance. Values
  /// are of the form
  ///  `projects/{project}/instances/{instance}`.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Instance,google/bigtable/admin/v2/instance.proto#L40}
  ///
  /// [google.bigtable.admin.v2.GetInstanceRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L317}
  /// [google.bigtable.admin.v2.Instance]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L40}
  ///
  StatusOr<google::bigtable::admin::v2::Instance> GetInstance(
      std::string const& name, Options opts = {});

  ///
  /// Gets information about an instance.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::GetInstanceRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L317}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Instance,google/bigtable/admin/v2/instance.proto#L40}
  ///
  /// [google.bigtable.admin.v2.GetInstanceRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L317}
  /// [google.bigtable.admin.v2.Instance]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L40}
  ///
  StatusOr<google::bigtable::admin::v2::Instance> GetInstance(
      google::bigtable::admin::v2::GetInstanceRequest const& request,
      Options opts = {});

  ///
  /// Lists information about instances in a project.
  ///
  /// @param parent  Required. The unique name of the project for which a list
  /// of instances is requested.
  ///  Values are of the form `projects/{project}`.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::ListInstancesResponse,google/bigtable/admin/v2/bigtable_instance_admin.proto#L344}
  ///
  /// [google.bigtable.admin.v2.ListInstancesRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L329}
  /// [google.bigtable.admin.v2.ListInstancesResponse]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L344}
  ///
  StatusOr<google::bigtable::admin::v2::ListInstancesResponse> ListInstances(
      std::string const& parent, Options opts = {});

  ///
  /// Lists information about instances in a project.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::ListInstancesRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L329}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::ListInstancesResponse,google/bigtable/admin/v2/bigtable_instance_admin.proto#L344}
  ///
  /// [google.bigtable.admin.v2.ListInstancesRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L329}
  /// [google.bigtable.admin.v2.ListInstancesResponse]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L344}
  ///
  StatusOr<google::bigtable::admin::v2::ListInstancesResponse> ListInstances(
      google::bigtable::admin::v2::ListInstancesRequest const& request,
      Options opts = {});

  ///
  /// Updates an instance within a project. This method updates only the display
  /// name and type for an Instance. To update other Instance properties, such
  /// as labels, use PartialUpdateInstance.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::Instance,google/bigtable/admin/v2/instance.proto#L40}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Instance,google/bigtable/admin/v2/instance.proto#L40}
  ///
  /// [google.bigtable.admin.v2.Instance]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L40}
  ///
  StatusOr<google::bigtable::admin::v2::Instance> UpdateInstance(
      google::bigtable::admin::v2::Instance const& request, Options opts = {});

  ///
  /// Partially updates an instance within a project. This method can modify all
  /// fields of an Instance and is the preferred way to update an Instance.
  ///
  /// @param instance  Required. The Instance which will (partially) replace the
  /// current value.
  /// @param update_mask  Required. The subset of Instance fields which should
  /// be replaced.
  ///  Must be explicitly set.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Instance,google/bigtable/admin/v2/instance.proto#L40}
  ///
  /// [google.bigtable.admin.v2.Instance]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L40}
  /// [google.bigtable.admin.v2.PartialUpdateInstanceRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L361}
  ///
  future<StatusOr<google::bigtable::admin::v2::Instance>> PartialUpdateInstance(
      google::bigtable::admin::v2::Instance const& instance,
      google::protobuf::FieldMask const& update_mask, Options opts = {});

  ///
  /// Partially updates an instance within a project. This method can modify all
  /// fields of an Instance and is the preferred way to update an Instance.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::PartialUpdateInstanceRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L361}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Instance,google/bigtable/admin/v2/instance.proto#L40}
  ///
  /// [google.bigtable.admin.v2.Instance]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L40}
  /// [google.bigtable.admin.v2.PartialUpdateInstanceRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L361}
  ///
  future<StatusOr<google::bigtable::admin::v2::Instance>> PartialUpdateInstance(
      google::bigtable::admin::v2::PartialUpdateInstanceRequest const& request,
      Options opts = {});

  ///
  /// Delete an instance from a project.
  ///
  /// @param name  Required. The unique name of the instance to be deleted.
  ///  Values are of the form `projects/{project}/instances/{instance}`.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  ///
  /// [google.bigtable.admin.v2.DeleteInstanceRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L371}
  ///
  Status DeleteInstance(std::string const& name, Options opts = {});

  ///
  /// Delete an instance from a project.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::DeleteInstanceRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L371}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  ///
  /// [google.bigtable.admin.v2.DeleteInstanceRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L371}
  ///
  Status DeleteInstance(
      google::bigtable::admin::v2::DeleteInstanceRequest const& request,
      Options opts = {});

  ///
  /// Creates a cluster within an instance.
  ///
  /// Note that exactly one of Cluster.serve_nodes and
  /// Cluster.cluster_config.cluster_autoscaling_config can be set. If
  /// serve_nodes is set to non-zero, then the cluster is manually scaled. If
  /// cluster_config.cluster_autoscaling_config is non-empty, then autoscaling
  /// is enabled.
  ///
  /// @param parent  Required. The unique name of the instance in which to
  /// create the new cluster.
  ///  Values are of the form
  ///  `projects/{project}/instances/{instance}`.
  /// @param cluster_id  Required. The ID to be used when referring to the new
  /// cluster within its instance,
  ///  e.g., just `mycluster` rather than
  ///  `projects/myproject/instances/myinstance/clusters/mycluster`.
  /// @param cluster  Required. The cluster to be created.
  ///  Fields marked `OutputOnly` must be left blank.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Cluster,google/bigtable/admin/v2/instance.proto#L143}
  ///
  /// [google.bigtable.admin.v2.Cluster]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L143}
  /// [google.bigtable.admin.v2.CreateClusterRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L383}
  ///
  future<StatusOr<google::bigtable::admin::v2::Cluster>> CreateCluster(
      std::string const& parent, std::string const& cluster_id,
      google::bigtable::admin::v2::Cluster const& cluster, Options opts = {});

  ///
  /// Creates a cluster within an instance.
  ///
  /// Note that exactly one of Cluster.serve_nodes and
  /// Cluster.cluster_config.cluster_autoscaling_config can be set. If
  /// serve_nodes is set to non-zero, then the cluster is manually scaled. If
  /// cluster_config.cluster_autoscaling_config is non-empty, then autoscaling
  /// is enabled.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::CreateClusterRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L383}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Cluster,google/bigtable/admin/v2/instance.proto#L143}
  ///
  /// [google.bigtable.admin.v2.Cluster]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L143}
  /// [google.bigtable.admin.v2.CreateClusterRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L383}
  ///
  future<StatusOr<google::bigtable::admin::v2::Cluster>> CreateCluster(
      google::bigtable::admin::v2::CreateClusterRequest const& request,
      Options opts = {});

  ///
  /// Gets information about a cluster.
  ///
  /// @param name  Required. The unique name of the requested cluster. Values
  /// are of the form
  ///  `projects/{project}/instances/{instance}/clusters/{cluster}`.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Cluster,google/bigtable/admin/v2/instance.proto#L143}
  ///
  /// [google.bigtable.admin.v2.Cluster]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L143}
  /// [google.bigtable.admin.v2.GetClusterRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L405}
  ///
  StatusOr<google::bigtable::admin::v2::Cluster> GetCluster(
      std::string const& name, Options opts = {});

  ///
  /// Gets information about a cluster.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::GetClusterRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L405}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Cluster,google/bigtable/admin/v2/instance.proto#L143}
  ///
  /// [google.bigtable.admin.v2.Cluster]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L143}
  /// [google.bigtable.admin.v2.GetClusterRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L405}
  ///
  StatusOr<google::bigtable::admin::v2::Cluster> GetCluster(
      google::bigtable::admin::v2::GetClusterRequest const& request,
      Options opts = {});

  ///
  /// Lists information about clusters in an instance.
  ///
  /// @param parent  Required. The unique name of the instance for which a list
  /// of clusters is requested.
  ///  Values are of the form `projects/{project}/instances/{instance}`.
  ///  Use `{instance} = '-'` to list Clusters for all Instances in a project,
  ///  e.g., `projects/myproject/instances/-`.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::ListClustersResponse,google/bigtable/admin/v2/bigtable_instance_admin.proto#L434}
  ///
  /// [google.bigtable.admin.v2.ListClustersRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L417}
  /// [google.bigtable.admin.v2.ListClustersResponse]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L434}
  ///
  StatusOr<google::bigtable::admin::v2::ListClustersResponse> ListClusters(
      std::string const& parent, Options opts = {});

  ///
  /// Lists information about clusters in an instance.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::ListClustersRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L417}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::ListClustersResponse,google/bigtable/admin/v2/bigtable_instance_admin.proto#L434}
  ///
  /// [google.bigtable.admin.v2.ListClustersRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L417}
  /// [google.bigtable.admin.v2.ListClustersResponse]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L434}
  ///
  StatusOr<google::bigtable::admin::v2::ListClustersResponse> ListClusters(
      google::bigtable::admin::v2::ListClustersRequest const& request,
      Options opts = {});

  ///
  /// Updates a cluster within an instance.
  ///
  /// Note that UpdateCluster does not support updating
  /// cluster_config.cluster_autoscaling_config. In order to update it, you
  /// must use PartialUpdateCluster.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::Cluster,google/bigtable/admin/v2/instance.proto#L143}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Cluster,google/bigtable/admin/v2/instance.proto#L143}
  ///
  /// [google.bigtable.admin.v2.Cluster]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L143}
  ///
  future<StatusOr<google::bigtable::admin::v2::Cluster>> UpdateCluster(
      google::bigtable::admin::v2::Cluster const& request, Options opts = {});

  ///
  /// Partially updates a cluster within a project. This method is the preferred
  /// way to update a Cluster.
  ///
  /// To enable and update autoscaling, set
  /// cluster_config.cluster_autoscaling_config. When autoscaling is enabled,
  /// serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it
  /// are ignored. Note that an update cannot simultaneously set serve_nodes to
  /// non-zero and cluster_config.cluster_autoscaling_config to non-empty, and
  /// also specify both in the update_mask.
  ///
  /// To disable autoscaling, clear cluster_config.cluster_autoscaling_config,
  /// and explicitly set a serve_node count via the update_mask.
  ///
  /// @param cluster  Required. The Cluster which contains the partial updates
  /// to be applied, subject to
  ///  the update_mask.
  /// @param update_mask  Required. The subset of Cluster fields which should be
  /// replaced.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Cluster,google/bigtable/admin/v2/instance.proto#L143}
  ///
  /// [google.bigtable.admin.v2.Cluster]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L143}
  /// [google.bigtable.admin.v2.PartialUpdateClusterRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L563}
  ///
  future<StatusOr<google::bigtable::admin::v2::Cluster>> PartialUpdateCluster(
      google::bigtable::admin::v2::Cluster const& cluster,
      google::protobuf::FieldMask const& update_mask, Options opts = {});

  ///
  /// Partially updates a cluster within a project. This method is the preferred
  /// way to update a Cluster.
  ///
  /// To enable and update autoscaling, set
  /// cluster_config.cluster_autoscaling_config. When autoscaling is enabled,
  /// serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it
  /// are ignored. Note that an update cannot simultaneously set serve_nodes to
  /// non-zero and cluster_config.cluster_autoscaling_config to non-empty, and
  /// also specify both in the update_mask.
  ///
  /// To disable autoscaling, clear cluster_config.cluster_autoscaling_config,
  /// and explicitly set a serve_node count via the update_mask.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::PartialUpdateClusterRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L563}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::Cluster,google/bigtable/admin/v2/instance.proto#L143}
  ///
  /// [google.bigtable.admin.v2.Cluster]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L143}
  /// [google.bigtable.admin.v2.PartialUpdateClusterRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L563}
  ///
  future<StatusOr<google::bigtable::admin::v2::Cluster>> PartialUpdateCluster(
      google::bigtable::admin::v2::PartialUpdateClusterRequest const& request,
      Options opts = {});

  ///
  /// Deletes a cluster from an instance.
  ///
  /// @param name  Required. The unique name of the cluster to be deleted.
  /// Values are of the form
  ///  `projects/{project}/instances/{instance}/clusters/{cluster}`.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  ///
  /// [google.bigtable.admin.v2.DeleteClusterRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L450}
  ///
  Status DeleteCluster(std::string const& name, Options opts = {});

  ///
  /// Deletes a cluster from an instance.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::DeleteClusterRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L450}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  ///
  /// [google.bigtable.admin.v2.DeleteClusterRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L450}
  ///
  Status DeleteCluster(
      google::bigtable::admin::v2::DeleteClusterRequest const& request,
      Options opts = {});

  ///
  /// Creates an app profile within an instance.
  ///
  /// @param parent  Required. The unique name of the instance in which to
  /// create the new app profile.
  ///  Values are of the form
  ///  `projects/{project}/instances/{instance}`.
  /// @param app_profile_id  Required. The ID to be used when referring to the
  /// new app profile within its
  ///  instance, e.g., just `myprofile` rather than
  ///  `projects/myproject/instances/myinstance/appProfiles/myprofile`.
  /// @param app_profile  Required. The app profile to be created.
  ///  Fields marked `OutputOnly` will be ignored.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::AppProfile,google/bigtable/admin/v2/instance.proto#L244}
  ///
  /// [google.bigtable.admin.v2.AppProfile]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L244}
  /// [google.bigtable.admin.v2.CreateAppProfileRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L573}
  ///
  StatusOr<google::bigtable::admin::v2::AppProfile> CreateAppProfile(
      std::string const& parent, std::string const& app_profile_id,
      google::bigtable::admin::v2::AppProfile const& app_profile,
      Options opts = {});

  ///
  /// Creates an app profile within an instance.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::CreateAppProfileRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L573}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::AppProfile,google/bigtable/admin/v2/instance.proto#L244}
  ///
  /// [google.bigtable.admin.v2.AppProfile]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L244}
  /// [google.bigtable.admin.v2.CreateAppProfileRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L573}
  ///
  StatusOr<google::bigtable::admin::v2::AppProfile> CreateAppProfile(
      google::bigtable::admin::v2::CreateAppProfileRequest const& request,
      Options opts = {});

  ///
  /// Gets information about an app profile.
  ///
  /// @param name  Required. The unique name of the requested app profile.
  /// Values are of the form
  ///  `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::AppProfile,google/bigtable/admin/v2/instance.proto#L244}
  ///
  /// [google.bigtable.admin.v2.AppProfile]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L244}
  /// [google.bigtable.admin.v2.GetAppProfileRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L598}
  ///
  StatusOr<google::bigtable::admin::v2::AppProfile> GetAppProfile(
      std::string const& name, Options opts = {});

  ///
  /// Gets information about an app profile.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::GetAppProfileRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L598}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::AppProfile,google/bigtable/admin/v2/instance.proto#L244}
  ///
  /// [google.bigtable.admin.v2.AppProfile]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L244}
  /// [google.bigtable.admin.v2.GetAppProfileRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L598}
  ///
  StatusOr<google::bigtable::admin::v2::AppProfile> GetAppProfile(
      google::bigtable::admin::v2::GetAppProfileRequest const& request,
      Options opts = {});

  ///
  /// Lists information about app profiles in an instance.
  ///
  /// @param parent  Required. The unique name of the instance for which a list
  /// of app profiles is
  ///  requested. Values are of the form
  ///  `projects/{project}/instances/{instance}`.
  ///  Use `{instance} = '-'` to list AppProfiles for all Instances in a
  ///  project, e.g., `projects/myproject/instances/-`.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::AppProfile,google/bigtable/admin/v2/instance.proto#L244}
  ///
  /// [google.bigtable.admin.v2.AppProfile]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L244}
  /// [google.bigtable.admin.v2.ListAppProfilesRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L610}
  ///
  StreamRange<google::bigtable::admin::v2::AppProfile> ListAppProfiles(
      std::string const& parent, Options opts = {});

  ///
  /// Lists information about app profiles in an instance.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::ListAppProfilesRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L610}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::AppProfile,google/bigtable/admin/v2/instance.proto#L244}
  ///
  /// [google.bigtable.admin.v2.AppProfile]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L244}
  /// [google.bigtable.admin.v2.ListAppProfilesRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L610}
  ///
  StreamRange<google::bigtable::admin::v2::AppProfile> ListAppProfiles(
      google::bigtable::admin::v2::ListAppProfilesRequest request,
      Options opts = {});

  ///
  /// Updates an app profile within an instance.
  ///
  /// @param app_profile  Required. The app profile which will (partially)
  /// replace the current value.
  /// @param update_mask  Required. The subset of app profile fields which
  /// should be replaced.
  ///  If unset, all fields will be replaced.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::AppProfile,google/bigtable/admin/v2/instance.proto#L244}
  ///
  /// [google.bigtable.admin.v2.AppProfile]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L244}
  /// [google.bigtable.admin.v2.UpdateAppProfileRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L656}
  ///
  future<StatusOr<google::bigtable::admin::v2::AppProfile>> UpdateAppProfile(
      google::bigtable::admin::v2::AppProfile const& app_profile,
      google::protobuf::FieldMask const& update_mask, Options opts = {});

  ///
  /// Updates an app profile within an instance.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::UpdateAppProfileRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L656}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::AppProfile,google/bigtable/admin/v2/instance.proto#L244}
  ///
  /// [google.bigtable.admin.v2.AppProfile]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L244}
  /// [google.bigtable.admin.v2.UpdateAppProfileRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L656}
  ///
  future<StatusOr<google::bigtable::admin::v2::AppProfile>> UpdateAppProfile(
      google::bigtable::admin::v2::UpdateAppProfileRequest const& request,
      Options opts = {});

  ///
  /// Deletes an app profile from an instance.
  ///
  /// @param name  Required. The unique name of the app profile to be deleted.
  /// Values are of the form
  ///  `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  ///
  /// [google.bigtable.admin.v2.DeleteAppProfileRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L669}
  ///
  Status DeleteAppProfile(std::string const& name, Options opts = {});

  ///
  /// Deletes an app profile from an instance.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::DeleteAppProfileRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L669}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  ///
  /// [google.bigtable.admin.v2.DeleteAppProfileRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L669}
  ///
  Status DeleteAppProfile(
      google::bigtable::admin::v2::DeleteAppProfileRequest const& request,
      Options opts = {});

  ///
  /// Gets the access control policy for an instance resource. Returns an empty
  /// policy if an instance exists but does not have a policy set.
  ///
  /// @param resource  REQUIRED: The resource for which the policy is being
  /// requested.
  ///  See the operation documentation for the appropriate value for this field.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::iam::v1::Policy,google/iam/v1/policy.proto#L98}
  ///
  /// [google.iam.v1.GetIamPolicyRequest]:
  /// @googleapis_reference_link{google/iam/v1/iam_policy.proto#L123}
  /// [google.iam.v1.Policy]:
  /// @googleapis_reference_link{google/iam/v1/policy.proto#L98}
  ///
  StatusOr<google::iam::v1::Policy> GetIamPolicy(std::string const& resource,
                                                 Options opts = {});

  ///
  /// Gets the access control policy for an instance resource. Returns an empty
  /// policy if an instance exists but does not have a policy set.
  ///
  /// @param request
  /// @googleapis_link{google::iam::v1::GetIamPolicyRequest,google/iam/v1/iam_policy.proto#L123}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::iam::v1::Policy,google/iam/v1/policy.proto#L98}
  ///
  /// [google.iam.v1.GetIamPolicyRequest]:
  /// @googleapis_reference_link{google/iam/v1/iam_policy.proto#L123}
  /// [google.iam.v1.Policy]:
  /// @googleapis_reference_link{google/iam/v1/policy.proto#L98}
  ///
  StatusOr<google::iam::v1::Policy> GetIamPolicy(
      google::iam::v1::GetIamPolicyRequest const& request, Options opts = {});

  ///
  /// Sets the access control policy on an instance resource. Replaces any
  /// existing policy.
  ///
  /// @param resource  REQUIRED: The resource for which the policy is being
  /// specified.
  ///  See the operation documentation for the appropriate value for this field.
  /// @param policy  REQUIRED: The complete policy to be applied to the
  /// `resource`. The size of
  ///  the policy is limited to a few 10s of KB. An empty policy is a
  ///  valid policy but certain Cloud Platform services (such as Projects)
  ///  might reject them.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::iam::v1::Policy,google/iam/v1/policy.proto#L98}
  ///
  /// [google.iam.v1.Policy]:
  /// @googleapis_reference_link{google/iam/v1/policy.proto#L98}
  /// [google.iam.v1.SetIamPolicyRequest]:
  /// @googleapis_reference_link{google/iam/v1/iam_policy.proto#L101}
  ///
  StatusOr<google::iam::v1::Policy> SetIamPolicy(
      std::string const& resource, google::iam::v1::Policy const& policy,
      Options opts = {});

  /**
   * Updates the IAM policy for @p resource using an optimistic concurrency
   * control loop.
   *
   * The loop fetches the current policy for @p resource, and passes it to @p
   * updater, which should return the new policy. This new policy should use the
   * current etag so that the read-modify-write cycle can detect races and rerun
   * the update when there is a mismatch. If the new policy does not have an
   * etag, the existing policy will be blindly overwritten. If @p updater does
   * not yield a policy, the control loop is terminated and kCancelled is
   * returned.
   *
   * @param resource  Required. The resource for which the policy is being
   * specified. See the operation documentation for the appropriate value for
   * this field.
   * @param updater  Required. Functor to map the current policy to a new one.
   * @param opts  Optional. Override the class-level options, such as retry and
   *    backoff policies.
   * @return google::iam::v1::Policy
   */
  StatusOr<google::iam::v1::Policy> SetIamPolicy(std::string const& resource,
                                                 IamUpdater const& updater,
                                                 Options opts = {});

  ///
  /// Sets the access control policy on an instance resource. Replaces any
  /// existing policy.
  ///
  /// @param request
  /// @googleapis_link{google::iam::v1::SetIamPolicyRequest,google/iam/v1/iam_policy.proto#L101}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::iam::v1::Policy,google/iam/v1/policy.proto#L98}
  ///
  /// [google.iam.v1.Policy]:
  /// @googleapis_reference_link{google/iam/v1/policy.proto#L98}
  /// [google.iam.v1.SetIamPolicyRequest]:
  /// @googleapis_reference_link{google/iam/v1/iam_policy.proto#L101}
  ///
  StatusOr<google::iam::v1::Policy> SetIamPolicy(
      google::iam::v1::SetIamPolicyRequest const& request, Options opts = {});

  ///
  /// Returns permissions that the caller has on the specified instance
  /// resource.
  ///
  /// @param resource  REQUIRED: The resource for which the policy detail is
  /// being requested.
  ///  See the operation documentation for the appropriate value for this field.
  /// @param permissions  The set of permissions to check for the `resource`.
  /// Permissions with
  ///  wildcards (such as '*' or 'storage.*') are not allowed. For more
  ///  information see
  ///  [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::iam::v1::TestIamPermissionsResponse,google/iam/v1/iam_policy.proto#L151}
  ///
  /// [google.iam.v1.TestIamPermissionsRequest]:
  /// @googleapis_reference_link{google/iam/v1/iam_policy.proto#L136}
  /// [google.iam.v1.TestIamPermissionsResponse]:
  /// @googleapis_reference_link{google/iam/v1/iam_policy.proto#L151}
  ///
  StatusOr<google::iam::v1::TestIamPermissionsResponse> TestIamPermissions(
      std::string const& resource, std::vector<std::string> const& permissions,
      Options opts = {});

  ///
  /// Returns permissions that the caller has on the specified instance
  /// resource.
  ///
  /// @param request
  /// @googleapis_link{google::iam::v1::TestIamPermissionsRequest,google/iam/v1/iam_policy.proto#L136}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::iam::v1::TestIamPermissionsResponse,google/iam/v1/iam_policy.proto#L151}
  ///
  /// [google.iam.v1.TestIamPermissionsRequest]:
  /// @googleapis_reference_link{google/iam/v1/iam_policy.proto#L136}
  /// [google.iam.v1.TestIamPermissionsResponse]:
  /// @googleapis_reference_link{google/iam/v1/iam_policy.proto#L151}
  ///
  StatusOr<google::iam::v1::TestIamPermissionsResponse> TestIamPermissions(
      google::iam::v1::TestIamPermissionsRequest const& request,
      Options opts = {});

  ///
  /// Lists hot tablets in a cluster, within the time range provided. Hot
  /// tablets are ordered based on CPU usage.
  ///
  /// @param parent  Required. The cluster name to list hot tablets.
  ///  Value is in the following form:
  ///  `projects/{project}/instances/{instance}/clusters/{cluster}`.
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::HotTablet,google/bigtable/admin/v2/instance.proto#L307}
  ///
  /// [google.bigtable.admin.v2.HotTablet]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L307}
  /// [google.bigtable.admin.v2.ListHotTabletsRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L689}
  ///
  StreamRange<google::bigtable::admin::v2::HotTablet> ListHotTablets(
      std::string const& parent, Options opts = {});

  ///
  /// Lists hot tablets in a cluster, within the time range provided. Hot
  /// tablets are ordered based on CPU usage.
  ///
  /// @param request
  /// @googleapis_link{google::bigtable::admin::v2::ListHotTabletsRequest,google/bigtable/admin/v2/bigtable_instance_admin.proto#L689}
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return
  /// @googleapis_link{google::bigtable::admin::v2::HotTablet,google/bigtable/admin/v2/instance.proto#L307}
  ///
  /// [google.bigtable.admin.v2.HotTablet]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/instance.proto#L307}
  /// [google.bigtable.admin.v2.ListHotTabletsRequest]:
  /// @googleapis_reference_link{google/bigtable/admin/v2/bigtable_instance_admin.proto#L689}
  ///
  StreamRange<google::bigtable::admin::v2::HotTablet> ListHotTablets(
      google::bigtable::admin::v2::ListHotTabletsRequest request,
      Options opts = {});

 private:
  std::shared_ptr<BigtableInstanceAdminConnection> connection_;
  Options options_;
};

GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
}  // namespace bigtable_admin
}  // namespace cloud
}  // namespace google

#endif  // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGTABLE_ADMIN_BIGTABLE_INSTANCE_ADMIN_CLIENT_H