Google Cloud Bigtable Administration v2 API - Class BigtableInstanceAdmin.BigtableInstanceAdminClient (3.17.0)

Version latest

• 3.17.0 (latest)
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0

public class BigtableInstanceAdmin.BigtableInstanceAdminClient : ClientBase<BigtableInstanceAdmin.BigtableInstanceAdminClient>

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

Client for BigtableInstanceAdmin

Inheritance

object > ClientBase > ClientBaseBigtableInstanceAdminBigtableInstanceAdminClient > BigtableInstanceAdmin.BigtableInstanceAdminClient

Inherited Members

ClientBase<BigtableInstanceAdmin.BigtableInstanceAdminClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

BigtableInstanceAdminClient()

protected BigtableInstanceAdminClient()

Protected parameterless constructor to allow creation of test doubles.

BigtableInstanceAdminClient(CallInvoker)

public BigtableInstanceAdminClient(CallInvoker callInvoker)

Creates a new client for BigtableInstanceAdmin that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

BigtableInstanceAdminClient(ChannelBase)

public BigtableInstanceAdminClient(ChannelBase channel)

Creates a new client for BigtableInstanceAdmin

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

BigtableInstanceAdminClient(ClientBaseConfiguration)

protected BigtableInstanceAdminClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateAppProfile(CreateAppProfileRequest, CallOptions)

public virtual AppProfile CreateAppProfile(CreateAppProfileRequest request, CallOptions options)

Creates an app profile within an instance.

Parameters
Name	Description
request	CreateAppProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AppProfile	The response received from the server.

CreateAppProfile(CreateAppProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AppProfile CreateAppProfile(CreateAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an app profile within an instance.

Parameters
Name	Description
request	CreateAppProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AppProfile	The response received from the server.

CreateAppProfileAsync(CreateAppProfileRequest, CallOptions)

public virtual AsyncUnaryCall<AppProfile> CreateAppProfileAsync(CreateAppProfileRequest request, CallOptions options)

Creates an app profile within an instance.

Parameters
Name	Description
request	CreateAppProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallAppProfile	The call object.

CreateAppProfileAsync(CreateAppProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AppProfile> CreateAppProfileAsync(CreateAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an app profile within an instance.

Parameters
Name	Description
request	CreateAppProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallAppProfile	The call object.

CreateCluster(CreateClusterRequest, CallOptions)

public virtual Operation CreateCluster(CreateClusterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateCluster(CreateClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateCluster(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateClusterAsync(CreateClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateClusterAsync(CreateClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateInstance(CreateInstanceRequest, CallOptions)

public virtual Operation CreateInstance(CreateInstanceRequest request, CallOptions 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
request	CreateInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateInstance(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
request	CreateInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateInstanceAsync(CreateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, CallOptions 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
request	CreateInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateInstanceAsync(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
request	CreateInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteAppProfile(DeleteAppProfileRequest, CallOptions)

public virtual Empty DeleteAppProfile(DeleteAppProfileRequest request, CallOptions options)

Deletes an app profile from an instance.

Parameters
Name	Description
request	DeleteAppProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteAppProfile(DeleteAppProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteAppProfile(DeleteAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an app profile from an instance.

Parameters
Name	Description
request	DeleteAppProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteAppProfileAsync(DeleteAppProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteAppProfileAsync(DeleteAppProfileRequest request, CallOptions options)

Deletes an app profile from an instance.

Parameters
Name	Description
request	DeleteAppProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteAppProfileAsync(DeleteAppProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteAppProfileAsync(DeleteAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an app profile from an instance.

Parameters
Name	Description
request	DeleteAppProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteCluster(DeleteClusterRequest, CallOptions)

public virtual Empty DeleteCluster(DeleteClusterRequest request, CallOptions options)

Deletes a cluster from an instance.

Parameters
Name	Description
request	DeleteClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteCluster(DeleteClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteCluster(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a cluster from an instance.

Parameters
Name	Description
request	DeleteClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteClusterAsync(DeleteClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteClusterAsync(DeleteClusterRequest request, CallOptions options)

Deletes a cluster from an instance.

Parameters
Name	Description
request	DeleteClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteClusterAsync(DeleteClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteClusterAsync(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a cluster from an instance.

Parameters
Name	Description
request	DeleteClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteInstance(DeleteInstanceRequest, CallOptions)

public virtual Empty DeleteInstance(DeleteInstanceRequest request, CallOptions options)

Delete an instance from a project.

Parameters
Name	Description
request	DeleteInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteInstance(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete an instance from a project.

Parameters
Name	Description
request	DeleteInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteInstanceAsync(DeleteInstanceRequest request, CallOptions options)

Delete an instance from a project.

Parameters
Name	Description
request	DeleteInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteInstanceAsync(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete an instance from a project.

Parameters
Name	Description
request	DeleteInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetAppProfile(GetAppProfileRequest, CallOptions)

public virtual AppProfile GetAppProfile(GetAppProfileRequest request, CallOptions options)

Gets information about an app profile.

Parameters
Name	Description
request	GetAppProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AppProfile	The response received from the server.

GetAppProfile(GetAppProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AppProfile GetAppProfile(GetAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about an app profile.

Parameters
Name	Description
request	GetAppProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AppProfile	The response received from the server.

GetAppProfileAsync(GetAppProfileRequest, CallOptions)

public virtual AsyncUnaryCall<AppProfile> GetAppProfileAsync(GetAppProfileRequest request, CallOptions options)

Gets information about an app profile.

Parameters
Name	Description
request	GetAppProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallAppProfile	The call object.

GetAppProfileAsync(GetAppProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AppProfile> GetAppProfileAsync(GetAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about an app profile.

Parameters
Name	Description
request	GetAppProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallAppProfile	The call object.

GetCluster(GetClusterRequest, CallOptions)

public virtual Cluster GetCluster(GetClusterRequest request, CallOptions options)

Gets information about a cluster.

Parameters
Name	Description
request	GetClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Cluster	The response received from the server.

GetCluster(GetClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Cluster GetCluster(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a cluster.

Parameters
Name	Description
request	GetClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Cluster	The response received from the server.

GetClusterAsync(GetClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Cluster> GetClusterAsync(GetClusterRequest request, CallOptions options)

Gets information about a cluster.

Parameters
Name	Description
request	GetClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallCluster	The call object.

GetClusterAsync(GetClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Cluster> GetClusterAsync(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a cluster.

Parameters
Name	Description
request	GetClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallCluster	The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions 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	GetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions 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	GetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Gets information about an instance.

Parameters
Name	Description
request	GetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Instance	The response received from the server.

GetInstance(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about an instance.

Parameters
Name	Description
request	GetInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Instance	The response received from the server.

GetInstanceAsync(GetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, CallOptions options)

Gets information about an instance.

Parameters
Name	Description
request	GetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallInstance	The call object.

GetInstanceAsync(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about an instance.

Parameters
Name	Description
request	GetInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallInstance	The call object.

ListAppProfiles(ListAppProfilesRequest, CallOptions)

public virtual ListAppProfilesResponse ListAppProfiles(ListAppProfilesRequest request, CallOptions options)

Lists information about app profiles in an instance.

Parameters
Name	Description
request	ListAppProfilesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListAppProfilesResponse	The response received from the server.

ListAppProfiles(ListAppProfilesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAppProfilesResponse ListAppProfiles(ListAppProfilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists information about app profiles in an instance.

Parameters
Name	Description
request	ListAppProfilesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListAppProfilesResponse	The response received from the server.

ListAppProfilesAsync(ListAppProfilesRequest, CallOptions)

public virtual AsyncUnaryCall<ListAppProfilesResponse> ListAppProfilesAsync(ListAppProfilesRequest request, CallOptions options)

Lists information about app profiles in an instance.

Parameters
Name	Description
request	ListAppProfilesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListAppProfilesResponse	The call object.

ListAppProfilesAsync(ListAppProfilesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAppProfilesResponse> ListAppProfilesAsync(ListAppProfilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists information about app profiles in an instance.

Parameters
Name	Description
request	ListAppProfilesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListAppProfilesResponse	The call object.

ListClusters(ListClustersRequest, CallOptions)

public virtual ListClustersResponse ListClusters(ListClustersRequest request, CallOptions options)

Lists information about clusters in an instance.

Parameters
Name	Description
request	ListClustersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListClustersResponse	The response received from the server.

ListClusters(ListClustersRequest, Metadata, DateTime?, CancellationToken)

public virtual ListClustersResponse ListClusters(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists information about clusters in an instance.

Parameters
Name	Description
request	ListClustersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListClustersResponse	The response received from the server.

ListClustersAsync(ListClustersRequest, CallOptions)

public virtual AsyncUnaryCall<ListClustersResponse> ListClustersAsync(ListClustersRequest request, CallOptions options)

Lists information about clusters in an instance.

Parameters
Name	Description
request	ListClustersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListClustersResponse	The call object.

ListClustersAsync(ListClustersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListClustersResponse> ListClustersAsync(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists information about clusters in an instance.

Parameters
Name	Description
request	ListClustersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListClustersResponse	The call object.

ListHotTablets(ListHotTabletsRequest, CallOptions)

public virtual ListHotTabletsResponse ListHotTablets(ListHotTabletsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListHotTabletsResponse	The response received from the server.

ListHotTablets(ListHotTabletsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListHotTabletsResponse ListHotTablets(ListHotTabletsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListHotTabletsResponse	The response received from the server.

ListHotTabletsAsync(ListHotTabletsRequest, CallOptions)

public virtual AsyncUnaryCall<ListHotTabletsResponse> ListHotTabletsAsync(ListHotTabletsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListHotTabletsResponse	The call object.

ListHotTabletsAsync(ListHotTabletsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListHotTabletsResponse> ListHotTabletsAsync(ListHotTabletsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListHotTabletsResponse	The call object.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

Lists information about instances in a project.

Parameters
Name	Description
request	ListInstancesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListInstancesResponse	The response received from the server.

ListInstances(ListInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists information about instances in a project.

Parameters
Name	Description
request	ListInstancesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListInstancesResponse	The response received from the server.

ListInstancesAsync(ListInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallOptions options)

Lists information about instances in a project.

Parameters
Name	Description
request	ListInstancesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListInstancesResponse	The call object.

ListInstancesAsync(ListInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists information about instances in a project.

Parameters
Name	Description
request	ListInstancesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListInstancesResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override BigtableInstanceAdmin.BigtableInstanceAdminClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
BigtableInstanceAdminBigtableInstanceAdminClient

Overrides

ClientBase<BigtableInstanceAdmin.BigtableInstanceAdminClient>.NewInstance(ClientBase.ClientBaseConfiguration)

PartialUpdateCluster(PartialUpdateClusterRequest, CallOptions)

public virtual Operation PartialUpdateCluster(PartialUpdateClusterRequest request, CallOptions 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
request	PartialUpdateClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

PartialUpdateCluster(PartialUpdateClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation PartialUpdateCluster(PartialUpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

PartialUpdateClusterAsync(PartialUpdateClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PartialUpdateClusterAsync(PartialUpdateClusterRequest request, CallOptions 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
request	PartialUpdateClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

PartialUpdateClusterAsync(PartialUpdateClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PartialUpdateClusterAsync(PartialUpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

PartialUpdateInstance(PartialUpdateInstanceRequest, CallOptions)

public virtual Operation PartialUpdateInstance(PartialUpdateInstanceRequest request, CallOptions 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	PartialUpdateInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

PartialUpdateInstance(PartialUpdateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation PartialUpdateInstance(PartialUpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

PartialUpdateInstanceAsync(PartialUpdateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PartialUpdateInstanceAsync(PartialUpdateInstanceRequest request, CallOptions 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	PartialUpdateInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

PartialUpdateInstanceAsync(PartialUpdateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PartialUpdateInstanceAsync(PartialUpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

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

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions options)

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

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

UpdateAppProfile(UpdateAppProfileRequest, CallOptions)

public virtual Operation UpdateAppProfile(UpdateAppProfileRequest request, CallOptions options)

Updates an app profile within an instance.

Parameters
Name	Description
request	UpdateAppProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateAppProfile(UpdateAppProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateAppProfile(UpdateAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an app profile within an instance.

Parameters
Name	Description
request	UpdateAppProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateAppProfileAsync(UpdateAppProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAppProfileAsync(UpdateAppProfileRequest request, CallOptions options)

Updates an app profile within an instance.

Parameters
Name	Description
request	UpdateAppProfileRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateAppProfileAsync(UpdateAppProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateAppProfileAsync(UpdateAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an app profile within an instance.

Parameters
Name	Description
request	UpdateAppProfileRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateCluster(Cluster, CallOptions)

public virtual Operation UpdateCluster(Cluster request, CallOptions 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	Cluster The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateCluster(Cluster, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateCluster(Cluster request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateClusterAsync(Cluster, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateClusterAsync(Cluster request, CallOptions 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	Cluster The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateClusterAsync(Cluster, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateClusterAsync(Cluster request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateInstance(Instance, CallOptions)

public virtual Instance UpdateInstance(Instance request, CallOptions 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	Instance The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Instance	The response received from the server.

UpdateInstance(Instance, Metadata, DateTime?, CancellationToken)

public virtual Instance UpdateInstance(Instance request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Instance	The response received from the server.

UpdateInstanceAsync(Instance, CallOptions)

public virtual AsyncUnaryCall<Instance> UpdateInstanceAsync(Instance request, CallOptions 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	Instance The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallInstance	The call object.

UpdateInstanceAsync(Instance, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Instance> UpdateInstanceAsync(Instance request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallInstance	The call object.