Class BigtableInstanceAdminClient (2.26.0)

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.

Constructors

BigtableInstanceAdminClient(BigtableInstanceAdminClient const &)

Copy and move support

Parameter
Name	Description
	`BigtableInstanceAdminClient const &`

BigtableInstanceAdminClient(BigtableInstanceAdminClient &&)

Copy and move support

Parameter
Name	Description
	`BigtableInstanceAdminClient &&`

BigtableInstanceAdminClient(std::shared_ptr< BigtableInstanceAdminConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< BigtableInstanceAdminConnection >`
`opts`	`Options`

Operators

operator=(BigtableInstanceAdminClient const &)

Copy and move support

Parameter
Name	Description
	`BigtableInstanceAdminClient const &`

Returns
Type	Description
`BigtableInstanceAdminClient &`

operator=(BigtableInstanceAdminClient &&)

Copy and move support

Parameter
Name	Description
	`BigtableInstanceAdminClient &&`

Returns
Type	Description
`BigtableInstanceAdminClient &`

Functions

CreateInstance(std::string const &, std::string const &, google::bigtable::admin::v2::Instance const &, std::map< std::string, google::bigtable::admin::v2::Cluster > const &, Options)

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
Name	Description
`parent`	`std::string const &` Required. The unique name of the project in which to create the new instance. Values are of the form `projects/{project}`.
`instance_id`	`std::string const &` 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`.
`instance`	`google::bigtable::admin::v2::Instance const &` Required. The instance to create. Fields marked `OutputOnly` must be left blank.
`clusters`	`std::map< std::string, google::bigtable::admin::v2::Cluster > const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateInstance(ExperimentalTag, NoAwaitTag, std::string const &, std::string const &, google::bigtable::admin::v2::Instance const &, std::map< std::string, google::bigtable::admin::v2::Cluster > const &, Options)

Create an instance within a project.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`parent`	`std::string const &`
`instance_id`	`std::string const &`
`instance`	`google::bigtable::admin::v2::Instance const &`
`clusters`	`std::map< std::string, google::bigtable::admin::v2::Cluster > const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateInstance(google::bigtable::admin::v2::CreateInstanceRequest const &, Options)

Create an instance within a project.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::CreateInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.CreateInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Instance > >

CreateInstance(ExperimentalTag, NoAwaitTag, google::bigtable::admin::v2::CreateInstanceRequest const &, Options)

Create an instance within a project.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::bigtable::admin::v2::CreateInstanceRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateInstance(ExperimentalTag, google::longrunning::Operation const &, Options)

Create an instance within a project.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::bigtable::admin::v2::Instance > >`

GetInstance(std::string const &, Options)

Gets information about an instance.

Parameters
Name	Description
`name`	`std::string const &` Required. The unique name of the requested instance. Values are of the form `projects/{project}/instances/{instance}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Instance >`	the result of the RPC. The response message type (google.bigtable.admin.v2.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetInstance(google::bigtable::admin::v2::GetInstanceRequest const &, Options)

Gets information about an instance.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::GetInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.GetInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Instance >`	the result of the RPC. The response message type (google.bigtable.admin.v2.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListInstances(std::string const &, Options)

Lists information about instances in a project.

Parameters
Name	Description
`parent`	`std::string const &` Required. The unique name of the project for which a list of instances is requested. Values are of the form `projects/{project}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::ListInstancesResponse >`	the result of the RPC. The response message type (google.bigtable.admin.v2.ListInstancesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListInstances(google::bigtable::admin::v2::ListInstancesRequest const &, Options)

Lists information about instances in a project.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::ListInstancesRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.ListInstancesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::ListInstancesResponse >`	the result of the RPC. The response message type (google.bigtable.admin.v2.ListInstancesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateInstance(google::bigtable::admin::v2::Instance const &, Options)

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
Name	Description
`request`	`google::bigtable::admin::v2::Instance const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.Instance. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Instance >`	the result of the RPC. The response message type (google.bigtable.admin.v2.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

PartialUpdateInstance(google::bigtable::admin::v2::Instance const &, google::protobuf::FieldMask const &, Options)

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
Name	Description
`instance`	`google::bigtable::admin::v2::Instance const &` Required. The Instance which will (partially) replace the current value.
`update_mask`	`google::protobuf::FieldMask const &` Required. The subset of Instance fields which should be replaced. Must be explicitly set.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Instance > >

PartialUpdateInstance(ExperimentalTag, NoAwaitTag, google::bigtable::admin::v2::Instance const &, google::protobuf::FieldMask const &, Options)

Partially updates an instance within a project.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`instance`	`google::bigtable::admin::v2::Instance const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

PartialUpdateInstance(google::bigtable::admin::v2::PartialUpdateInstanceRequest const &, Options)

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
Name	Description
`request`	`google::bigtable::admin::v2::PartialUpdateInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.PartialUpdateInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Instance > >

PartialUpdateInstance(ExperimentalTag, NoAwaitTag, google::bigtable::admin::v2::PartialUpdateInstanceRequest const &, Options)

Partially updates an instance within a project.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::bigtable::admin::v2::PartialUpdateInstanceRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

PartialUpdateInstance(ExperimentalTag, google::longrunning::Operation const &, Options)

Partially updates an instance within a project.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::bigtable::admin::v2::Instance > >`

DeleteInstance(std::string const &, Options)

Delete an instance from a project.

Parameters
Name	Description
`name`	`std::string const &` Required. The unique name of the instance to be deleted. Values are of the form `projects/{project}/instances/{instance}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteInstance(google::bigtable::admin::v2::DeleteInstanceRequest const &, Options)

Delete an instance from a project.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::DeleteInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.DeleteInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CreateCluster(std::string const &, std::string const &, google::bigtable::admin::v2::Cluster const &, Options)

Creates a cluster within an instance.

Parameters
Name	Description
`parent`	`std::string const &` Required. The unique name of the instance in which to create the new cluster. Values are of the form `projects/{project}/instances/{instance}`.
`cluster_id`	`std::string const &` 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`.
`cluster`	`google::bigtable::admin::v2::Cluster const &` Required. The cluster to be created. Fields marked `OutputOnly` must be left blank.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Cluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCluster(ExperimentalTag, NoAwaitTag, std::string const &, std::string const &, google::bigtable::admin::v2::Cluster const &, Options)

Creates a cluster within an instance.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`parent`	`std::string const &`
`cluster_id`	`std::string const &`
`cluster`	`google::bigtable::admin::v2::Cluster const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateCluster(google::bigtable::admin::v2::CreateClusterRequest const &, Options)

Creates a cluster within an instance.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::CreateClusterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.CreateClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Cluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCluster(ExperimentalTag, NoAwaitTag, google::bigtable::admin::v2::CreateClusterRequest const &, Options)

Creates a cluster within an instance.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::bigtable::admin::v2::CreateClusterRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateCluster(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates a cluster within an instance.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::bigtable::admin::v2::Cluster > >`

GetCluster(std::string const &, Options)

Gets information about a cluster.

Parameters
Name	Description
`name`	`std::string const &` Required. The unique name of the requested cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Cluster >`	the result of the RPC. The response message type (google.bigtable.admin.v2.Cluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetCluster(google::bigtable::admin::v2::GetClusterRequest const &, Options)

Gets information about a cluster.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::GetClusterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.GetClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Cluster >`	the result of the RPC. The response message type (google.bigtable.admin.v2.Cluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListClusters(std::string const &, Options)

Lists information about clusters in an instance.

Parameters
Name	Description
`parent`	`std::string const &` 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/-`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::ListClustersResponse >`	the result of the RPC. The response message type (google.bigtable.admin.v2.ListClustersResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListClusters(google::bigtable::admin::v2::ListClustersRequest const &, Options)

Lists information about clusters in an instance.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::ListClustersRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.ListClustersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::ListClustersResponse >`	the result of the RPC. The response message type (google.bigtable.admin.v2.ListClustersResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateCluster(google::bigtable::admin::v2::Cluster const &, Options)

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
Name	Description
`request`	`google::bigtable::admin::v2::Cluster const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.Cluster. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Cluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateCluster(ExperimentalTag, NoAwaitTag, google::bigtable::admin::v2::Cluster const &, Options)

Updates a cluster within an instance.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::bigtable::admin::v2::Cluster const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

UpdateCluster(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates a cluster within an instance.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::bigtable::admin::v2::Cluster > >`

PartialUpdateCluster(google::bigtable::admin::v2::Cluster const &, google::protobuf::FieldMask const &, Options)

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
Name	Description
`cluster`	`google::bigtable::admin::v2::Cluster const &` Required. The Cluster which contains the partial updates to be applied, subject to the update_mask.
`update_mask`	`google::protobuf::FieldMask const &` Required. The subset of Cluster fields which should be replaced.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Cluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PartialUpdateCluster(ExperimentalTag, NoAwaitTag, google::bigtable::admin::v2::Cluster const &, google::protobuf::FieldMask const &, Options)

Partially updates a cluster within a project.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`cluster`	`google::bigtable::admin::v2::Cluster const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

PartialUpdateCluster(google::bigtable::admin::v2::PartialUpdateClusterRequest const &, Options)

Partially updates a cluster within a project.

This method is the preferred way to update a Cluster.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::PartialUpdateClusterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.PartialUpdateClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Cluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PartialUpdateCluster(ExperimentalTag, NoAwaitTag, google::bigtable::admin::v2::PartialUpdateClusterRequest const &, Options)

Partially updates a cluster within a project.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::bigtable::admin::v2::PartialUpdateClusterRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

PartialUpdateCluster(ExperimentalTag, google::longrunning::Operation const &, Options)

Partially updates a cluster within a project.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::bigtable::admin::v2::Cluster > >`

DeleteCluster(std::string const &, Options)

Deletes a cluster from an instance.

Parameters
Name	Description
`name`	`std::string const &` Required. The unique name of the cluster to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteCluster(google::bigtable::admin::v2::DeleteClusterRequest const &, Options)

Deletes a cluster from an instance.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::DeleteClusterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.DeleteClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CreateAppProfile(std::string const &, std::string const &, google::bigtable::admin::v2::AppProfile const &, Options)

Creates an app profile within an instance.

Parameters
Name	Description
`parent`	`std::string const &` Required. 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_id`	`std::string const &` 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`.
`app_profile`	`google::bigtable::admin::v2::AppProfile const &` Required. The app profile to be created. Fields marked `OutputOnly` will be ignored.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::AppProfile >`	the result of the RPC. The response message type (google.bigtable.admin.v2.AppProfile) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateAppProfile(google::bigtable::admin::v2::CreateAppProfileRequest const &, Options)

Creates an app profile within an instance.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::CreateAppProfileRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.CreateAppProfileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::AppProfile >`	the result of the RPC. The response message type (google.bigtable.admin.v2.AppProfile) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetAppProfile(std::string const &, Options)

Gets information about an app profile.

Parameters
Name	Description
`name`	`std::string const &` Required. The unique name of the requested app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::AppProfile >`	the result of the RPC. The response message type (google.bigtable.admin.v2.AppProfile) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetAppProfile(google::bigtable::admin::v2::GetAppProfileRequest const &, Options)

Gets information about an app profile.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::GetAppProfileRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.GetAppProfileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::AppProfile >`	the result of the RPC. The response message type (google.bigtable.admin.v2.AppProfile) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListAppProfiles(std::string const &, Options)

Lists information about app profiles in an instance.

Parameters
Name	Description
`parent`	`std::string const &` 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/-`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::bigtable::admin::v2::AppProfile >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.bigtable.admin.v2.AppProfile, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAppProfiles(google::bigtable::admin::v2::ListAppProfilesRequest, Options)

Lists information about app profiles in an instance.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::ListAppProfilesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.ListAppProfilesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::bigtable::admin::v2::AppProfile >

UpdateAppProfile(google::bigtable::admin::v2::AppProfile const &, google::protobuf::FieldMask const &, Options)

Updates an app profile within an instance.

Parameters
Name	Description
`app_profile`	`google::bigtable::admin::v2::AppProfile const &` Required. The app profile which will (partially) replace the current value.
`update_mask`	`google::protobuf::FieldMask const &` Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::AppProfile > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.AppProfile proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAppProfile(ExperimentalTag, NoAwaitTag, google::bigtable::admin::v2::AppProfile const &, google::protobuf::FieldMask const &, Options)

Updates an app profile within an instance.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`app_profile`	`google::bigtable::admin::v2::AppProfile const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

UpdateAppProfile(google::bigtable::admin::v2::UpdateAppProfileRequest const &, Options)

Updates an app profile within an instance.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::UpdateAppProfileRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.UpdateAppProfileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::AppProfile > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.AppProfile proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAppProfile(ExperimentalTag, NoAwaitTag, google::bigtable::admin::v2::UpdateAppProfileRequest const &, Options)

Updates an app profile within an instance.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::bigtable::admin::v2::UpdateAppProfileRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

UpdateAppProfile(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates an app profile within an instance.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::bigtable::admin::v2::AppProfile > >`

DeleteAppProfile(google::bigtable::admin::v2::DeleteAppProfileRequest const &, Options)

Deletes an app profile from an instance.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::DeleteAppProfileRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.DeleteAppProfileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

GetIamPolicy(std::string const &, Options)

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
Name	Description
`resource`	`std::string const &` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

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
Name	Description
`request`	`google::iam::v1::GetIamPolicyRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetIamPolicy(std::string const &, google::iam::v1::Policy const &, Options)

Sets the access control policy on an instance resource.

Replaces any existing policy.

Parameters
Name	Description
`resource`	`std::string const &` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`policy`	`google::iam::v1::Policy const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetIamPolicy(std::string const &, IamUpdater const &, Options)

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
Name	Description
`resource`	`std::string const &` Required. The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`updater`	`IamUpdater const &` Required. Functor to map the current policy to a new one.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	google::iam::v1::Policy

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on an instance resource.

Replaces any existing policy.

Parameters
Name	Description
`request`	`google::iam::v1::SetIamPolicyRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

TestIamPermissions(std::string const &, std::vector< std::string > const &, Options)

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

Parameters
Name	Description
`resource`	`std::string const &` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	`std::vector< std::string > const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::TestIamPermissionsResponse >`	the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

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

Parameters
Name	Description
`request`	`google::iam::v1::TestIamPermissionsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::TestIamPermissionsResponse >`	the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListHotTablets(std::string const &, Options)

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

Hot tablets are ordered based on CPU usage.

Parameters
Name	Description
`parent`	`std::string const &` Required. The cluster name to list hot tablets. Value is in the following form: `projects/{project}/instances/{instance}/clusters/{cluster}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::bigtable::admin::v2::HotTablet >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.bigtable.admin.v2.HotTablet, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListHotTablets(google::bigtable::admin::v2::ListHotTabletsRequest, Options)

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

Hot tablets are ordered based on CPU usage.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::ListHotTabletsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.ListHotTabletsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::bigtable::admin::v2::HotTablet >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.bigtable.admin.v2.HotTablet, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.