Struct google_api_proto::google::bigtable::admin::v2::bigtable_instance_admin_client::BigtableInstanceAdminClient

pub struct BigtableInstanceAdminClient<T> { /* private fields */ }

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.

Implementations

impl<T> BigtableInstanceAdminClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> BigtableInstanceAdminClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn create_instance( &mut self, request: impl IntoRequest<CreateInstanceRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn get_instance( &mut self, request: impl IntoRequest<GetInstanceRequest>, ) -> Result<Response<Instance>, Status>

Gets information about an instance.

pub async fn list_instances( &mut self, request: impl IntoRequest<ListInstancesRequest>, ) -> Result<Response<ListInstancesResponse>, Status>

Lists information about instances in a project.

pub async fn update_instance( &mut self, request: impl IntoRequest<Instance>, ) -> Result<Response<Instance>, Status>

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.

pub async fn partial_update_instance( &mut self, request: impl IntoRequest<PartialUpdateInstanceRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn delete_instance( &mut self, request: impl IntoRequest<DeleteInstanceRequest>, ) -> Result<Response<()>, Status>

Delete an instance from a project.

pub async fn create_cluster( &mut self, request: impl IntoRequest<CreateClusterRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn get_cluster( &mut self, request: impl IntoRequest<GetClusterRequest>, ) -> Result<Response<Cluster>, Status>

Gets information about a cluster.

pub async fn list_clusters( &mut self, request: impl IntoRequest<ListClustersRequest>, ) -> Result<Response<ListClustersResponse>, Status>

Lists information about clusters in an instance.

pub async fn update_cluster( &mut self, request: impl IntoRequest<Cluster>, ) -> Result<Response<Operation>, Status>

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.

pub async fn partial_update_cluster( &mut self, request: impl IntoRequest<PartialUpdateClusterRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn delete_cluster( &mut self, request: impl IntoRequest<DeleteClusterRequest>, ) -> Result<Response<()>, Status>

Deletes a cluster from an instance.

pub async fn create_app_profile( &mut self, request: impl IntoRequest<CreateAppProfileRequest>, ) -> Result<Response<AppProfile>, Status>

Creates an app profile within an instance.

pub async fn get_app_profile( &mut self, request: impl IntoRequest<GetAppProfileRequest>, ) -> Result<Response<AppProfile>, Status>

Gets information about an app profile.

pub async fn list_app_profiles( &mut self, request: impl IntoRequest<ListAppProfilesRequest>, ) -> Result<Response<ListAppProfilesResponse>, Status>

Lists information about app profiles in an instance.

pub async fn update_app_profile( &mut self, request: impl IntoRequest<UpdateAppProfileRequest>, ) -> Result<Response<Operation>, Status>

Updates an app profile within an instance.

pub async fn delete_app_profile( &mut self, request: impl IntoRequest<DeleteAppProfileRequest>, ) -> Result<Response<()>, Status>

Deletes an app profile from an instance.

pub async fn get_iam_policy( &mut self, request: impl IntoRequest<GetIamPolicyRequest>, ) -> Result<Response<Policy>, Status>

Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.

pub async fn set_iam_policy( &mut self, request: impl IntoRequest<SetIamPolicyRequest>, ) -> Result<Response<Policy>, Status>

Sets the access control policy on an instance resource. Replaces any existing policy.

pub async fn test_iam_permissions( &mut self, request: impl IntoRequest<TestIamPermissionsRequest>, ) -> Result<Response<TestIamPermissionsResponse>, Status>

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

pub async fn list_hot_tablets( &mut self, request: impl IntoRequest<ListHotTabletsRequest>, ) -> Result<Response<ListHotTabletsResponse>, Status>

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

Trait Implementations

impl<T: Clone> Clone for BigtableInstanceAdminClient<T>

fn clone(&self) -> BigtableInstanceAdminClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for BigtableInstanceAdminClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.