Google Cloud Bigtable C++ Client  2.5.0
A C++ Client Library for Google Cloud Bigtable
Public Member Functions | List of all members
google::cloud::bigtable_admin::BigtableInstanceAdminClient Class Reference

Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. More...

#include <google/cloud/bigtable/admin/bigtable_instance_admin_client.h>

Public Member Functions

 BigtableInstanceAdminClient (std::shared_ptr< BigtableInstanceAdminConnection > connection, Options opts={})
 
 ~BigtableInstanceAdminClient ()
 
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. More...
 
future< StatusOr< google::bigtable::admin::v2::Instance > > CreateInstance (google::bigtable::admin::v2::CreateInstanceRequest const &request, Options opts={})
 Create an instance within a project. More...
 
StatusOr< google::bigtable::admin::v2::Instance > GetInstance (std::string const &name, Options opts={})
 Gets information about an instance. More...
 
StatusOr< google::bigtable::admin::v2::Instance > GetInstance (google::bigtable::admin::v2::GetInstanceRequest const &request, Options opts={})
 Gets information about an instance. More...
 
StatusOr< google::bigtable::admin::v2::ListInstancesResponse > ListInstances (std::string const &parent, Options opts={})
 Lists information about instances in a project. More...
 
StatusOr< google::bigtable::admin::v2::ListInstancesResponse > ListInstances (google::bigtable::admin::v2::ListInstancesRequest const &request, Options opts={})
 Lists information about instances in a project. More...
 
StatusOr< google::bigtable::admin::v2::Instance > UpdateInstance (google::bigtable::admin::v2::Instance const &request, Options opts={})
 Updates an instance within a project. More...
 
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. More...
 
future< StatusOr< google::bigtable::admin::v2::Instance > > PartialUpdateInstance (google::bigtable::admin::v2::PartialUpdateInstanceRequest const &request, Options opts={})
 Partially updates an instance within a project. More...
 
Status DeleteInstance (std::string const &name, Options opts={})
 Delete an instance from a project. More...
 
Status DeleteInstance (google::bigtable::admin::v2::DeleteInstanceRequest const &request, Options opts={})
 Delete an instance from a project. More...
 
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. More...
 
future< StatusOr< google::bigtable::admin::v2::Cluster > > CreateCluster (google::bigtable::admin::v2::CreateClusterRequest const &request, Options opts={})
 Creates a cluster within an instance. More...
 
StatusOr< google::bigtable::admin::v2::Cluster > GetCluster (std::string const &name, Options opts={})
 Gets information about a cluster. More...
 
StatusOr< google::bigtable::admin::v2::Cluster > GetCluster (google::bigtable::admin::v2::GetClusterRequest const &request, Options opts={})
 Gets information about a cluster. More...
 
StatusOr< google::bigtable::admin::v2::ListClustersResponse > ListClusters (std::string const &parent, Options opts={})
 Lists information about clusters in an instance. More...
 
StatusOr< google::bigtable::admin::v2::ListClustersResponse > ListClusters (google::bigtable::admin::v2::ListClustersRequest const &request, Options opts={})
 Lists information about clusters in an instance. More...
 
future< StatusOr< google::bigtable::admin::v2::Cluster > > UpdateCluster (google::bigtable::admin::v2::Cluster const &request, Options opts={})
 Updates a cluster within an instance. More...
 
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. More...
 
future< StatusOr< google::bigtable::admin::v2::Cluster > > PartialUpdateCluster (google::bigtable::admin::v2::PartialUpdateClusterRequest const &request, Options opts={})
 Partially updates a cluster within a project. More...
 
Status DeleteCluster (std::string const &name, Options opts={})
 Deletes a cluster from an instance. More...
 
Status DeleteCluster (google::bigtable::admin::v2::DeleteClusterRequest const &request, Options opts={})
 Deletes a cluster from an instance. More...
 
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. More...
 
StatusOr< google::bigtable::admin::v2::AppProfile > CreateAppProfile (google::bigtable::admin::v2::CreateAppProfileRequest const &request, Options opts={})
 Creates an app profile within an instance. More...
 
StatusOr< google::bigtable::admin::v2::AppProfile > GetAppProfile (std::string const &name, Options opts={})
 Gets information about an app profile. More...
 
StatusOr< google::bigtable::admin::v2::AppProfile > GetAppProfile (google::bigtable::admin::v2::GetAppProfileRequest const &request, Options opts={})
 Gets information about an app profile. More...
 
StreamRange< google::bigtable::admin::v2::AppProfile > ListAppProfiles (std::string const &parent, Options opts={})
 Lists information about app profiles in an instance. More...
 
StreamRange< google::bigtable::admin::v2::AppProfile > ListAppProfiles (google::bigtable::admin::v2::ListAppProfilesRequest request, Options opts={})
 Lists information about app profiles in an instance. More...
 
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. More...
 
future< StatusOr< google::bigtable::admin::v2::AppProfile > > UpdateAppProfile (google::bigtable::admin::v2::UpdateAppProfileRequest const &request, Options opts={})
 Updates an app profile within an instance. More...
 
Status DeleteAppProfile (std::string const &name, Options opts={})
 Deletes an app profile from an instance. More...
 
Status DeleteAppProfile (google::bigtable::admin::v2::DeleteAppProfileRequest const &request, Options opts={})
 Deletes an app profile from an instance. More...
 
StatusOr< google::iam::v1::Policy > GetIamPolicy (std::string const &resource, Options opts={})
 Gets the access control policy for an instance resource. More...
 
StatusOr< google::iam::v1::Policy > GetIamPolicy (google::iam::v1::GetIamPolicyRequest const &request, Options opts={})
 Gets the access control policy for an instance resource. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (std::string const &resource, google::iam::v1::Policy const &policy, Options opts={})
 Sets the access control policy on an instance resource. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (std::string const &resource, IamUpdater const &updater, Options opts={})
 Updates the IAM policy for resource using an optimistic concurrency control loop. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (google::iam::v1::SetIamPolicyRequest const &request, Options opts={})
 Sets the access control policy on an instance resource. More...
 
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. More...
 
StatusOr< google::iam::v1::TestIamPermissionsResponse > TestIamPermissions (google::iam::v1::TestIamPermissionsRequest const &request, Options opts={})
 Returns permissions that the caller has on the specified instance resource. More...
 
StreamRange< google::bigtable::admin::v2::HotTablet > ListHotTablets (std::string const &parent, Options opts={})
 Lists hot tablets in a cluster, within the time range provided. More...
 
StreamRange< google::bigtable::admin::v2::HotTablet > ListHotTablets (google::bigtable::admin::v2::ListHotTabletsRequest request, Options opts={})
 Lists hot tablets in a cluster, within the time range provided. More...
 
 BigtableInstanceAdminClient (BigtableInstanceAdminClient const &)=default
 
BigtableInstanceAdminClientoperator= (BigtableInstanceAdminClient const &)=default
 
 BigtableInstanceAdminClient (BigtableInstanceAdminClient &&)=default
 
BigtableInstanceAdminClientoperator= (BigtableInstanceAdminClient &&)=default
 

Friends

bool operator== (BigtableInstanceAdminClient const &a, BigtableInstanceAdminClient const &b)
 
bool operator!= (BigtableInstanceAdminClient const &a, BigtableInstanceAdminClient const &b)
 

Detailed Description

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.

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.

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.

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.

Definition at line 66 of file bigtable_instance_admin_client.h.

Constructor & Destructor Documentation

◆ BigtableInstanceAdminClient() [1/3]

google::cloud::bigtable_admin::BigtableInstanceAdminClient::BigtableInstanceAdminClient ( std::shared_ptr< BigtableInstanceAdminConnection connection,
Options  opts = {} 
)
explicit

◆ ~BigtableInstanceAdminClient()

google::cloud::bigtable_admin::BigtableInstanceAdminClient::~BigtableInstanceAdminClient ( )

◆ BigtableInstanceAdminClient() [2/3]

google::cloud::bigtable_admin::BigtableInstanceAdminClient::BigtableInstanceAdminClient ( BigtableInstanceAdminClient const &  )
default

◆ BigtableInstanceAdminClient() [3/3]

google::cloud::bigtable_admin::BigtableInstanceAdminClient::BigtableInstanceAdminClient ( BigtableInstanceAdminClient &&  )
default

Member Function Documentation

◆ CreateAppProfile() [1/2]

StatusOr<google::bigtable::admin::v2::AppProfile> google::cloud::bigtable_admin::BigtableInstanceAdminClient::CreateAppProfile ( google::bigtable::admin::v2::CreateAppProfileRequest const &  request,
Options  opts = {} 
)

Creates an app profile within an instance.

Parameters
requestgoogle::bigtable::admin::v2::CreateAppProfileRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::AppProfile

◆ CreateAppProfile() [2/2]

StatusOr<google::bigtable::admin::v2::AppProfile> google::cloud::bigtable_admin::BigtableInstanceAdminClient::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.

Parameters
parentRequired. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.
app_profile_idRequired. 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.
app_profileRequired. The app profile to be created. Fields marked OutputOnly will be ignored.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::AppProfile

◆ CreateCluster() [1/2]

future<StatusOr<google::bigtable::admin::v2::Cluster> > google::cloud::bigtable_admin::BigtableInstanceAdminClient::CreateCluster ( google::bigtable::admin::v2::CreateClusterRequest 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.

Parameters
requestgoogle::bigtable::admin::v2::CreateClusterRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Cluster

◆ CreateCluster() [2/2]

future<StatusOr<google::bigtable::admin::v2::Cluster> > google::cloud::bigtable_admin::BigtableInstanceAdminClient::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.

Parameters
parentRequired. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.
cluster_idRequired. 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.
clusterRequired. The cluster to be created. Fields marked OutputOnly must be left blank.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Cluster

◆ CreateInstance() [1/2]

future<StatusOr<google::bigtable::admin::v2::Instance> > google::cloud::bigtable_admin::BigtableInstanceAdminClient::CreateInstance ( google::bigtable::admin::v2::CreateInstanceRequest const &  request,
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.

Parameters
requestgoogle::bigtable::admin::v2::CreateInstanceRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Instance

◆ CreateInstance() [2/2]

future<StatusOr<google::bigtable::admin::v2::Instance> > google::cloud::bigtable_admin::BigtableInstanceAdminClient::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.

Parameters
parentRequired. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.
instance_idRequired. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.
instanceRequired. The instance to create. Fields marked OutputOnly must be left blank.
clustersRequired. 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.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Instance

◆ DeleteAppProfile() [1/2]

Status google::cloud::bigtable_admin::BigtableInstanceAdminClient::DeleteAppProfile ( google::bigtable::admin::v2::DeleteAppProfileRequest const &  request,
Options  opts = {} 
)

Deletes an app profile from an instance.

Parameters
requestgoogle::bigtable::admin::v2::DeleteAppProfileRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteAppProfile() [2/2]

Status google::cloud::bigtable_admin::BigtableInstanceAdminClient::DeleteAppProfile ( std::string const &  name,
Options  opts = {} 
)

Deletes an app profile from an instance.

Parameters
nameRequired. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteCluster() [1/2]

Status google::cloud::bigtable_admin::BigtableInstanceAdminClient::DeleteCluster ( google::bigtable::admin::v2::DeleteClusterRequest const &  request,
Options  opts = {} 
)

Deletes a cluster from an instance.

Parameters
requestgoogle::bigtable::admin::v2::DeleteClusterRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteCluster() [2/2]

Status google::cloud::bigtable_admin::BigtableInstanceAdminClient::DeleteCluster ( std::string const &  name,
Options  opts = {} 
)

Deletes a cluster from an instance.

Parameters
nameRequired. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteInstance() [1/2]

Status google::cloud::bigtable_admin::BigtableInstanceAdminClient::DeleteInstance ( google::bigtable::admin::v2::DeleteInstanceRequest const &  request,
Options  opts = {} 
)

Delete an instance from a project.

Parameters
requestgoogle::bigtable::admin::v2::DeleteInstanceRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteInstance() [2/2]

Status google::cloud::bigtable_admin::BigtableInstanceAdminClient::DeleteInstance ( std::string const &  name,
Options  opts = {} 
)

Delete an instance from a project.

Parameters
nameRequired. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ GetAppProfile() [1/2]

StatusOr<google::bigtable::admin::v2::AppProfile> google::cloud::bigtable_admin::BigtableInstanceAdminClient::GetAppProfile ( google::bigtable::admin::v2::GetAppProfileRequest const &  request,
Options  opts = {} 
)

Gets information about an app profile.

Parameters
requestgoogle::bigtable::admin::v2::GetAppProfileRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::AppProfile

◆ GetAppProfile() [2/2]

StatusOr<google::bigtable::admin::v2::AppProfile> google::cloud::bigtable_admin::BigtableInstanceAdminClient::GetAppProfile ( std::string const &  name,
Options  opts = {} 
)

Gets information about an app profile.

Parameters
nameRequired. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::AppProfile

◆ GetCluster() [1/2]

StatusOr<google::bigtable::admin::v2::Cluster> google::cloud::bigtable_admin::BigtableInstanceAdminClient::GetCluster ( google::bigtable::admin::v2::GetClusterRequest const &  request,
Options  opts = {} 
)

Gets information about a cluster.

Parameters
requestgoogle::bigtable::admin::v2::GetClusterRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Cluster

◆ GetCluster() [2/2]

StatusOr<google::bigtable::admin::v2::Cluster> google::cloud::bigtable_admin::BigtableInstanceAdminClient::GetCluster ( std::string const &  name,
Options  opts = {} 
)

Gets information about a cluster.

Parameters
nameRequired. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Cluster

◆ GetIamPolicy() [1/2]

StatusOr<google::iam::v1::Policy> google::cloud::bigtable_admin::BigtableInstanceAdminClient::GetIamPolicy ( google::iam::v1::GetIamPolicyRequest 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.

Parameters
requestgoogle::iam::v1::GetIamPolicyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ GetIamPolicy() [2/2]

StatusOr<google::iam::v1::Policy> google::cloud::bigtable_admin::BigtableInstanceAdminClient::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.

Parameters
resourceREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ GetInstance() [1/2]

StatusOr<google::bigtable::admin::v2::Instance> google::cloud::bigtable_admin::BigtableInstanceAdminClient::GetInstance ( google::bigtable::admin::v2::GetInstanceRequest const &  request,
Options  opts = {} 
)

Gets information about an instance.

Parameters
requestgoogle::bigtable::admin::v2::GetInstanceRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Instance

◆ GetInstance() [2/2]

StatusOr<google::bigtable::admin::v2::Instance> google::cloud::bigtable_admin::BigtableInstanceAdminClient::GetInstance ( std::string const &  name,
Options  opts = {} 
)

Gets information about an instance.

Parameters
nameRequired. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Instance

◆ ListAppProfiles() [1/2]

StreamRange<google::bigtable::admin::v2::AppProfile> google::cloud::bigtable_admin::BigtableInstanceAdminClient::ListAppProfiles ( google::bigtable::admin::v2::ListAppProfilesRequest  request,
Options  opts = {} 
)

Lists information about app profiles in an instance.

Parameters
requestgoogle::bigtable::admin::v2::ListAppProfilesRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::AppProfile

◆ ListAppProfiles() [2/2]

StreamRange<google::bigtable::admin::v2::AppProfile> google::cloud::bigtable_admin::BigtableInstanceAdminClient::ListAppProfiles ( std::string const &  parent,
Options  opts = {} 
)

Lists information about app profiles in an instance.

Parameters
parentRequired. 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/-`.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::AppProfile

◆ ListClusters() [1/2]

StatusOr<google::bigtable::admin::v2::ListClustersResponse> google::cloud::bigtable_admin::BigtableInstanceAdminClient::ListClusters ( google::bigtable::admin::v2::ListClustersRequest const &  request,
Options  opts = {} 
)

Lists information about clusters in an instance.

Parameters
requestgoogle::bigtable::admin::v2::ListClustersRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::ListClustersResponse

◆ ListClusters() [2/2]

StatusOr<google::bigtable::admin::v2::ListClustersResponse> google::cloud::bigtable_admin::BigtableInstanceAdminClient::ListClusters ( std::string const &  parent,
Options  opts = {} 
)

Lists information about clusters in an instance.

Parameters
parentRequired. 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/-`.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::ListClustersResponse

◆ ListHotTablets() [1/2]

StreamRange<google::bigtable::admin::v2::HotTablet> google::cloud::bigtable_admin::BigtableInstanceAdminClient::ListHotTablets ( google::bigtable::admin::v2::ListHotTabletsRequest  request,
Options  opts = {} 
)

Lists hot tablets in a cluster, within the time range provided.

Hot tablets are ordered based on CPU usage.

Parameters
requestgoogle::bigtable::admin::v2::ListHotTabletsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::HotTablet

◆ ListHotTablets() [2/2]

StreamRange<google::bigtable::admin::v2::HotTablet> google::cloud::bigtable_admin::BigtableInstanceAdminClient::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.

Parameters
parentRequired. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::HotTablet

◆ ListInstances() [1/2]

StatusOr<google::bigtable::admin::v2::ListInstancesResponse> google::cloud::bigtable_admin::BigtableInstanceAdminClient::ListInstances ( google::bigtable::admin::v2::ListInstancesRequest const &  request,
Options  opts = {} 
)

Lists information about instances in a project.

Parameters
requestgoogle::bigtable::admin::v2::ListInstancesRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::ListInstancesResponse

◆ ListInstances() [2/2]

StatusOr<google::bigtable::admin::v2::ListInstancesResponse> google::cloud::bigtable_admin::BigtableInstanceAdminClient::ListInstances ( std::string const &  parent,
Options  opts = {} 
)

Lists information about instances in a project.

Parameters
parentRequired. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::ListInstancesResponse

◆ operator=() [1/2]

BigtableInstanceAdminClient& google::cloud::bigtable_admin::BigtableInstanceAdminClient::operator= ( BigtableInstanceAdminClient &&  )
default

◆ operator=() [2/2]

BigtableInstanceAdminClient& google::cloud::bigtable_admin::BigtableInstanceAdminClient::operator= ( BigtableInstanceAdminClient const &  )
default

◆ PartialUpdateCluster() [1/2]

future<StatusOr<google::bigtable::admin::v2::Cluster> > google::cloud::bigtable_admin::BigtableInstanceAdminClient::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.

Parameters
clusterRequired. The Cluster which contains the partial updates to be applied, subject to the update_mask.
update_maskRequired. The subset of Cluster fields which should be replaced.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Cluster

◆ PartialUpdateCluster() [2/2]

future<StatusOr<google::bigtable::admin::v2::Cluster> > google::cloud::bigtable_admin::BigtableInstanceAdminClient::PartialUpdateCluster ( google::bigtable::admin::v2::PartialUpdateClusterRequest 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.

Parameters
requestgoogle::bigtable::admin::v2::PartialUpdateClusterRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Cluster

◆ PartialUpdateInstance() [1/2]

future<StatusOr<google::bigtable::admin::v2::Instance> > google::cloud::bigtable_admin::BigtableInstanceAdminClient::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.

Parameters
instanceRequired. The Instance which will (partially) replace the current value.
update_maskRequired. The subset of Instance fields which should be replaced. Must be explicitly set.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Instance

◆ PartialUpdateInstance() [2/2]

future<StatusOr<google::bigtable::admin::v2::Instance> > google::cloud::bigtable_admin::BigtableInstanceAdminClient::PartialUpdateInstance ( google::bigtable::admin::v2::PartialUpdateInstanceRequest 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.

Parameters
requestgoogle::bigtable::admin::v2::PartialUpdateInstanceRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Instance

◆ SetIamPolicy() [1/3]

StatusOr<google::iam::v1::Policy> google::cloud::bigtable_admin::BigtableInstanceAdminClient::SetIamPolicy ( google::iam::v1::SetIamPolicyRequest const &  request,
Options  opts = {} 
)

Sets the access control policy on an instance resource.

Replaces any existing policy.

Parameters
requestgoogle::iam::v1::SetIamPolicyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ SetIamPolicy() [2/3]

StatusOr<google::iam::v1::Policy> google::cloud::bigtable_admin::BigtableInstanceAdminClient::SetIamPolicy ( std::string const &  resource,
google::iam::v1::Policy const &  policy,
Options  opts = {} 
)

Sets the access control policy on an instance resource.

Replaces any existing policy.

Parameters
resourceREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policyREQUIRED: 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.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ SetIamPolicy() [3/3]

StatusOr<google::iam::v1::Policy> google::cloud::bigtable_admin::BigtableInstanceAdminClient::SetIamPolicy ( std::string const &  resource,
IamUpdater const &  updater,
Options  opts = {} 
)

Updates the IAM policy for resource using an optimistic concurrency control loop.

The loop fetches the current policy for resource, and passes it to 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 updater does not yield a policy, the control loop is terminated and kCancelled is returned.

Parameters
resourceRequired. The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
updaterRequired. Functor to map the current policy to a new one.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ TestIamPermissions() [1/2]

StatusOr<google::iam::v1::TestIamPermissionsResponse> google::cloud::bigtable_admin::BigtableInstanceAdminClient::TestIamPermissions ( google::iam::v1::TestIamPermissionsRequest const &  request,
Options  opts = {} 
)

Returns permissions that the caller has on the specified instance resource.

Parameters
requestgoogle::iam::v1::TestIamPermissionsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::TestIamPermissionsResponse

◆ TestIamPermissions() [2/2]

StatusOr<google::iam::v1::TestIamPermissionsResponse> google::cloud::bigtable_admin::BigtableInstanceAdminClient::TestIamPermissions ( std::string const &  resource,
std::vector< std::string > const &  permissions,
Options  opts = {} 
)

Returns permissions that the caller has on the specified instance resource.

Parameters
resourceREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissionsThe set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::TestIamPermissionsResponse

◆ UpdateAppProfile() [1/2]

future<StatusOr<google::bigtable::admin::v2::AppProfile> > google::cloud::bigtable_admin::BigtableInstanceAdminClient::UpdateAppProfile ( google::bigtable::admin::v2::AppProfile const &  app_profile,
google::protobuf::FieldMask const &  update_mask,
Options  opts = {} 
)

Updates an app profile within an instance.

Parameters
app_profileRequired. The app profile which will (partially) replace the current value.
update_maskRequired. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::AppProfile

◆ UpdateAppProfile() [2/2]

future<StatusOr<google::bigtable::admin::v2::AppProfile> > google::cloud::bigtable_admin::BigtableInstanceAdminClient::UpdateAppProfile ( google::bigtable::admin::v2::UpdateAppProfileRequest const &  request,
Options  opts = {} 
)

Updates an app profile within an instance.

Parameters
requestgoogle::bigtable::admin::v2::UpdateAppProfileRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::AppProfile

◆ UpdateCluster()

future<StatusOr<google::bigtable::admin::v2::Cluster> > google::cloud::bigtable_admin::BigtableInstanceAdminClient::UpdateCluster ( google::bigtable::admin::v2::Cluster 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.

Parameters
requestgoogle::bigtable::admin::v2::Cluster
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Cluster

◆ UpdateInstance()

StatusOr<google::bigtable::admin::v2::Instance> google::cloud::bigtable_admin::BigtableInstanceAdminClient::UpdateInstance ( google::bigtable::admin::v2::Instance 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.

Parameters
requestgoogle::bigtable::admin::v2::Instance
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Instance

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( BigtableInstanceAdminClient const &  a,
BigtableInstanceAdminClient const &  b 
)
friend

Definition at line 89 of file bigtable_instance_admin_client.h.

◆ operator==

bool operator== ( BigtableInstanceAdminClient const &  a,
BigtableInstanceAdminClient const &  b 
)
friend

Definition at line 85 of file bigtable_instance_admin_client.h.