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.

Class BigtableInstanceAdmin.BigtableInstanceAdminBase (3.1.0)

[BindServiceMethod(typeof(BigtableInstanceAdmin), "BindService")]
public abstract class 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
`Task<AppProfile>`	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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<Empty>`	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
`Task<Empty>`	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
`Task<Empty>`	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
`Task<AppProfile>`	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
`Task<Cluster>`	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
`Task<Policy>`	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
`Task<Instance>`	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
`Task<ListAppProfilesResponse>`	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
`Task<ListClustersResponse>`	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
`Task<ListHotTabletsResponse>`	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
`Task<ListInstancesResponse>`	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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<Policy>`	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
`Task<TestIamPermissionsResponse>`	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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<Instance>`	The response to send back to the client (wrapped by a task).