Google Cloud Bigtable Administration v2 API - Class BigtableInstanceAdmin.BigtableInstanceAdminBase (3.11.0)

[BindServiceMethod(typeof(BigtableInstanceAdmin), "BindService")]
public abstract class BigtableInstanceAdmin.BigtableInstanceAdminBase

Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class BigtableInstanceAdmin.BigtableInstanceAdminBase.

Base class for server-side implementations of BigtableInstanceAdmin

Inheritance

object > BigtableInstanceAdmin.BigtableInstanceAdminBase

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Methods

CreateAppProfile(CreateAppProfileRequest, ServerCallContext)

public virtual Task<AppProfile> CreateAppProfile(CreateAppProfileRequest request, ServerCallContext context)

Creates an app profile within an instance.

Parameters
NameDescription
requestCreateAppProfileRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskAppProfile

The response to send back to the client (wrapped by a task).

CreateCluster(CreateClusterRequest, ServerCallContext)

public virtual Task<Operation> CreateCluster(CreateClusterRequest request, ServerCallContext context)

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
NameDescription
requestCreateClusterRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

CreateInstance(CreateInstanceRequest, ServerCallContext)

public virtual Task<Operation> CreateInstance(CreateInstanceRequest request, ServerCallContext context)

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
NameDescription
requestCreateInstanceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteAppProfile(DeleteAppProfileRequest, ServerCallContext)

public virtual Task<Empty> DeleteAppProfile(DeleteAppProfileRequest request, ServerCallContext context)

Deletes an app profile from an instance.

Parameters
NameDescription
requestDeleteAppProfileRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteCluster(DeleteClusterRequest, ServerCallContext)

public virtual Task<Empty> DeleteCluster(DeleteClusterRequest request, ServerCallContext context)

Deletes a cluster from an instance.

Parameters
NameDescription
requestDeleteClusterRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteInstance(DeleteInstanceRequest, ServerCallContext)

public virtual Task<Empty> DeleteInstance(DeleteInstanceRequest request, ServerCallContext context)

Delete an instance from a project.

Parameters
NameDescription
requestDeleteInstanceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

GetAppProfile(GetAppProfileRequest, ServerCallContext)

public virtual Task<AppProfile> GetAppProfile(GetAppProfileRequest request, ServerCallContext context)

Gets information about an app profile.

Parameters
NameDescription
requestGetAppProfileRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskAppProfile

The response to send back to the client (wrapped by a task).

GetCluster(GetClusterRequest, ServerCallContext)

public virtual Task<Cluster> GetCluster(GetClusterRequest request, ServerCallContext context)

Gets information about a cluster.

Parameters
NameDescription
requestGetClusterRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskCluster

The response to send back to the client (wrapped by a task).

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)

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
NameDescription
requestGetIamPolicyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskPolicy

The response to send back to the client (wrapped by a task).

GetInstance(GetInstanceRequest, ServerCallContext)

public virtual Task<Instance> GetInstance(GetInstanceRequest request, ServerCallContext context)

Gets information about an instance.

Parameters
NameDescription
requestGetInstanceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskInstance

The response to send back to the client (wrapped by a task).

ListAppProfiles(ListAppProfilesRequest, ServerCallContext)

public virtual Task<ListAppProfilesResponse> ListAppProfiles(ListAppProfilesRequest request, ServerCallContext context)

Lists information about app profiles in an instance.

Parameters
NameDescription
requestListAppProfilesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListAppProfilesResponse

The response to send back to the client (wrapped by a task).

ListClusters(ListClustersRequest, ServerCallContext)

public virtual Task<ListClustersResponse> ListClusters(ListClustersRequest request, ServerCallContext context)

Lists information about clusters in an instance.

Parameters
NameDescription
requestListClustersRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListClustersResponse

The response to send back to the client (wrapped by a task).

ListHotTablets(ListHotTabletsRequest, ServerCallContext)

public virtual Task<ListHotTabletsResponse> ListHotTablets(ListHotTabletsRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestListHotTabletsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListHotTabletsResponse

The response to send back to the client (wrapped by a task).

ListInstances(ListInstancesRequest, ServerCallContext)

public virtual Task<ListInstancesResponse> ListInstances(ListInstancesRequest request, ServerCallContext context)

Lists information about instances in a project.

Parameters
NameDescription
requestListInstancesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListInstancesResponse

The response to send back to the client (wrapped by a task).

PartialUpdateCluster(PartialUpdateClusterRequest, ServerCallContext)

public virtual Task<Operation> PartialUpdateCluster(PartialUpdateClusterRequest request, ServerCallContext context)

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
NameDescription
requestPartialUpdateClusterRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

PartialUpdateInstance(PartialUpdateInstanceRequest, ServerCallContext)

public virtual Task<Operation> PartialUpdateInstance(PartialUpdateInstanceRequest request, ServerCallContext context)

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
NameDescription
requestPartialUpdateInstanceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestSetIamPolicyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskPolicy

The response to send back to the client (wrapped by a task).

TestIamPermissions(TestIamPermissionsRequest, ServerCallContext)

public virtual Task<TestIamPermissionsResponse> TestIamPermissions(TestIamPermissionsRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestTestIamPermissionsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskTestIamPermissionsResponse

The response to send back to the client (wrapped by a task).

UpdateAppProfile(UpdateAppProfileRequest, ServerCallContext)

public virtual Task<Operation> UpdateAppProfile(UpdateAppProfileRequest request, ServerCallContext context)

Updates an app profile within an instance.

Parameters
NameDescription
requestUpdateAppProfileRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateCluster(Cluster, ServerCallContext)

public virtual Task<Operation> UpdateCluster(Cluster request, ServerCallContext context)

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
NameDescription
requestCluster

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateInstance(Instance, ServerCallContext)

public virtual Task<Instance> UpdateInstance(Instance request, ServerCallContext context)

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
NameDescription
requestInstance

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskInstance

The response to send back to the client (wrapped by a task).