Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Google Cloud Bigtable Administration v2 API - Class BigtableInstanceAdmin.BigtableInstanceAdminBase (3.30.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

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
`request`	`CreateAppProfileRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`CreateClusterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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.

Parameters
Name	Description
`request`	`CreateInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateLogicalView(CreateLogicalViewRequest, ServerCallContext)

public virtual Task<Operation> CreateLogicalView(CreateLogicalViewRequest request, ServerCallContext context)

Creates a logical view within an instance.

Parameters
Name	Description
`request`	`CreateLogicalViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateMaterializedView(CreateMaterializedViewRequest, ServerCallContext)

public virtual Task<Operation> CreateMaterializedView(CreateMaterializedViewRequest request, ServerCallContext context)

Creates a materialized view within an instance.

Parameters
Name	Description
`request`	`CreateMaterializedViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`DeleteAppProfileRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`DeleteClusterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`DeleteInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

DeleteLogicalView(DeleteLogicalViewRequest, ServerCallContext)

public virtual Task<Empty> DeleteLogicalView(DeleteLogicalViewRequest request, ServerCallContext context)

Deletes a logical view from an instance.

Parameters
Name	Description
`request`	`DeleteLogicalViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

DeleteMaterializedView(DeleteMaterializedViewRequest, ServerCallContext)

public virtual Task<Empty> DeleteMaterializedView(DeleteMaterializedViewRequest request, ServerCallContext context)

Deletes a materialized view from an instance.

Parameters
Name	Description
`request`	`DeleteMaterializedViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetAppProfileRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetClusterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetIamPolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskInstance`	The response to send back to the client (wrapped by a task).

GetLogicalView(GetLogicalViewRequest, ServerCallContext)

public virtual Task<LogicalView> GetLogicalView(GetLogicalViewRequest request, ServerCallContext context)

Gets information about a logical view.

Parameters
Name	Description
`request`	`GetLogicalViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskLogicalView`	The response to send back to the client (wrapped by a task).

GetMaterializedView(GetMaterializedViewRequest, ServerCallContext)

public virtual Task<MaterializedView> GetMaterializedView(GetMaterializedViewRequest request, ServerCallContext context)

Gets information about a materialized view.

Parameters
Name	Description
`request`	`GetMaterializedViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskMaterializedView`	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
Name	Description
`request`	`ListAppProfilesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListClustersRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListHotTabletsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListInstancesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListInstancesResponse`	The response to send back to the client (wrapped by a task).

ListLogicalViews(ListLogicalViewsRequest, ServerCallContext)

public virtual Task<ListLogicalViewsResponse> ListLogicalViews(ListLogicalViewsRequest request, ServerCallContext context)

Lists information about logical views in an instance.

Parameters
Name	Description
`request`	`ListLogicalViewsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListLogicalViewsResponse`	The response to send back to the client (wrapped by a task).

ListMaterializedViews(ListMaterializedViewsRequest, ServerCallContext)

public virtual Task<ListMaterializedViewsResponse> ListMaterializedViews(ListMaterializedViewsRequest request, ServerCallContext context)

Lists information about materialized views in an instance.

Parameters
Name	Description
`request`	`ListMaterializedViewsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListMaterializedViewsResponse`	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
Name	Description
`request`	`PartialUpdateClusterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`PartialUpdateInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`SetIamPolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`TestIamPermissionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`UpdateAppProfileRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`Cluster` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`Instance` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskInstance`	The response to send back to the client (wrapped by a task).

UpdateLogicalView(UpdateLogicalViewRequest, ServerCallContext)

public virtual Task<Operation> UpdateLogicalView(UpdateLogicalViewRequest request, ServerCallContext context)

Updates a logical view within an instance.

Parameters
Name	Description
`request`	`UpdateLogicalViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateMaterializedView(UpdateMaterializedViewRequest, ServerCallContext)

public virtual Task<Operation> UpdateMaterializedView(UpdateMaterializedViewRequest request, ServerCallContext context)

Updates a materialized view within an instance.

Parameters
Name	Description
`request`	`UpdateMaterializedViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).