Google Cloud Bigtable Administration v2 API - Class BigtableInstanceAdminClientImpl (3.3.0)

public sealed class BigtableInstanceAdminClientImpl : BigtableInstanceAdminClient

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

BigtableInstanceAdmin client wrapper implementation, for convenient use.

Inheritance

Object > BigtableInstanceAdminClient > BigtableInstanceAdminClientImpl

Inherited Members

BigtableInstanceAdminClient.DefaultEndpoint

BigtableInstanceAdminClient.DefaultScopes

BigtableInstanceAdminClient.ServiceMetadata

BigtableInstanceAdminClient.CreateAsync(CancellationToken)

BigtableInstanceAdminClient.Create()

BigtableInstanceAdminClient.ShutdownDefaultChannelsAsync()

BigtableInstanceAdminClient.CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

BigtableInstanceAdminClient.PollOnceCreateInstance(String, CallSettings)

BigtableInstanceAdminClient.PollOnceCreateInstanceAsync(String, CallSettings)

BigtableInstanceAdminClient.CreateInstance(String, String, Instance, IDictionary<String, Cluster>, CallSettings)

BigtableInstanceAdminClient.CreateInstanceAsync(String, String, Instance, IDictionary<String, Cluster>, CallSettings)

BigtableInstanceAdminClient.CreateInstanceAsync(String, String, Instance, IDictionary<String, Cluster>, CancellationToken)

BigtableInstanceAdminClient.CreateInstance(ProjectName, String, Instance, IDictionary<String, Cluster>, CallSettings)

BigtableInstanceAdminClient.CreateInstanceAsync(ProjectName, String, Instance, IDictionary<String, Cluster>, CallSettings)

BigtableInstanceAdminClient.CreateInstanceAsync(ProjectName, String, Instance, IDictionary<String, Cluster>, CancellationToken)

BigtableInstanceAdminClient.GetInstanceAsync(GetInstanceRequest, CancellationToken)

BigtableInstanceAdminClient.GetInstance(String, CallSettings)

BigtableInstanceAdminClient.GetInstanceAsync(String, CallSettings)

BigtableInstanceAdminClient.GetInstanceAsync(String, CancellationToken)

BigtableInstanceAdminClient.GetInstance(InstanceName, CallSettings)

BigtableInstanceAdminClient.GetInstanceAsync(InstanceName, CallSettings)

BigtableInstanceAdminClient.GetInstanceAsync(InstanceName, CancellationToken)

BigtableInstanceAdminClient.ListInstancesAsync(ListInstancesRequest, CancellationToken)

BigtableInstanceAdminClient.ListInstances(String, CallSettings)

BigtableInstanceAdminClient.ListInstancesAsync(String, CallSettings)

BigtableInstanceAdminClient.ListInstancesAsync(String, CancellationToken)

BigtableInstanceAdminClient.ListInstances(ProjectName, CallSettings)

BigtableInstanceAdminClient.ListInstancesAsync(ProjectName, CallSettings)

BigtableInstanceAdminClient.ListInstancesAsync(ProjectName, CancellationToken)

BigtableInstanceAdminClient.UpdateInstanceAsync(Instance, CancellationToken)

BigtableInstanceAdminClient.PartialUpdateInstanceAsync(PartialUpdateInstanceRequest, CancellationToken)

BigtableInstanceAdminClient.PollOncePartialUpdateInstance(String, CallSettings)

BigtableInstanceAdminClient.PollOncePartialUpdateInstanceAsync(String, CallSettings)

BigtableInstanceAdminClient.PartialUpdateInstance(Instance, FieldMask, CallSettings)

BigtableInstanceAdminClient.PartialUpdateInstanceAsync(Instance, FieldMask, CallSettings)

BigtableInstanceAdminClient.PartialUpdateInstanceAsync(Instance, FieldMask, CancellationToken)

BigtableInstanceAdminClient.DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

BigtableInstanceAdminClient.DeleteInstance(String, CallSettings)

BigtableInstanceAdminClient.DeleteInstanceAsync(String, CallSettings)

BigtableInstanceAdminClient.DeleteInstanceAsync(String, CancellationToken)

BigtableInstanceAdminClient.DeleteInstance(InstanceName, CallSettings)

BigtableInstanceAdminClient.DeleteInstanceAsync(InstanceName, CallSettings)

BigtableInstanceAdminClient.DeleteInstanceAsync(InstanceName, CancellationToken)

BigtableInstanceAdminClient.CreateClusterAsync(CreateClusterRequest, CancellationToken)

BigtableInstanceAdminClient.PollOnceCreateCluster(String, CallSettings)

BigtableInstanceAdminClient.PollOnceCreateClusterAsync(String, CallSettings)

BigtableInstanceAdminClient.CreateCluster(String, String, Cluster, CallSettings)

BigtableInstanceAdminClient.CreateClusterAsync(String, String, Cluster, CallSettings)

BigtableInstanceAdminClient.CreateClusterAsync(String, String, Cluster, CancellationToken)

BigtableInstanceAdminClient.CreateCluster(InstanceName, String, Cluster, CallSettings)

BigtableInstanceAdminClient.CreateClusterAsync(InstanceName, String, Cluster, CallSettings)

BigtableInstanceAdminClient.CreateClusterAsync(InstanceName, String, Cluster, CancellationToken)

BigtableInstanceAdminClient.GetClusterAsync(GetClusterRequest, CancellationToken)

BigtableInstanceAdminClient.GetCluster(String, CallSettings)

BigtableInstanceAdminClient.GetClusterAsync(String, CallSettings)

BigtableInstanceAdminClient.GetClusterAsync(String, CancellationToken)

BigtableInstanceAdminClient.GetCluster(ClusterName, CallSettings)

BigtableInstanceAdminClient.GetClusterAsync(ClusterName, CallSettings)

BigtableInstanceAdminClient.GetClusterAsync(ClusterName, CancellationToken)

BigtableInstanceAdminClient.ListClustersAsync(ListClustersRequest, CancellationToken)

BigtableInstanceAdminClient.ListClusters(String, CallSettings)

BigtableInstanceAdminClient.ListClustersAsync(String, CallSettings)

BigtableInstanceAdminClient.ListClustersAsync(String, CancellationToken)

BigtableInstanceAdminClient.ListClusters(InstanceName, CallSettings)

BigtableInstanceAdminClient.ListClustersAsync(InstanceName, CallSettings)

BigtableInstanceAdminClient.ListClustersAsync(InstanceName, CancellationToken)

BigtableInstanceAdminClient.UpdateClusterAsync(Cluster, CancellationToken)

BigtableInstanceAdminClient.PollOnceUpdateCluster(String, CallSettings)

BigtableInstanceAdminClient.PollOnceUpdateClusterAsync(String, CallSettings)

BigtableInstanceAdminClient.PartialUpdateClusterAsync(PartialUpdateClusterRequest, CancellationToken)

BigtableInstanceAdminClient.PollOncePartialUpdateCluster(String, CallSettings)

BigtableInstanceAdminClient.PollOncePartialUpdateClusterAsync(String, CallSettings)

BigtableInstanceAdminClient.PartialUpdateCluster(Cluster, FieldMask, CallSettings)

BigtableInstanceAdminClient.PartialUpdateClusterAsync(Cluster, FieldMask, CallSettings)

BigtableInstanceAdminClient.PartialUpdateClusterAsync(Cluster, FieldMask, CancellationToken)

BigtableInstanceAdminClient.DeleteClusterAsync(DeleteClusterRequest, CancellationToken)

BigtableInstanceAdminClient.DeleteCluster(String, CallSettings)

BigtableInstanceAdminClient.DeleteClusterAsync(String, CallSettings)

BigtableInstanceAdminClient.DeleteClusterAsync(String, CancellationToken)

BigtableInstanceAdminClient.DeleteCluster(ClusterName, CallSettings)

BigtableInstanceAdminClient.DeleteClusterAsync(ClusterName, CallSettings)

BigtableInstanceAdminClient.DeleteClusterAsync(ClusterName, CancellationToken)

BigtableInstanceAdminClient.CreateAppProfileAsync(CreateAppProfileRequest, CancellationToken)

BigtableInstanceAdminClient.CreateAppProfile(String, String, AppProfile, CallSettings)

BigtableInstanceAdminClient.CreateAppProfileAsync(String, String, AppProfile, CallSettings)

BigtableInstanceAdminClient.CreateAppProfileAsync(String, String, AppProfile, CancellationToken)

BigtableInstanceAdminClient.CreateAppProfile(InstanceName, String, AppProfile, CallSettings)

BigtableInstanceAdminClient.CreateAppProfileAsync(InstanceName, String, AppProfile, CallSettings)

BigtableInstanceAdminClient.CreateAppProfileAsync(InstanceName, String, AppProfile, CancellationToken)

BigtableInstanceAdminClient.GetAppProfileAsync(GetAppProfileRequest, CancellationToken)

BigtableInstanceAdminClient.GetAppProfile(String, CallSettings)

BigtableInstanceAdminClient.GetAppProfileAsync(String, CallSettings)

BigtableInstanceAdminClient.GetAppProfileAsync(String, CancellationToken)

BigtableInstanceAdminClient.GetAppProfile(AppProfileName, CallSettings)

BigtableInstanceAdminClient.GetAppProfileAsync(AppProfileName, CallSettings)

BigtableInstanceAdminClient.GetAppProfileAsync(AppProfileName, CancellationToken)

BigtableInstanceAdminClient.ListAppProfiles(String, String, Nullable<Int32>, CallSettings)

BigtableInstanceAdminClient.ListAppProfilesAsync(String, String, Nullable<Int32>, CallSettings)

BigtableInstanceAdminClient.ListAppProfiles(InstanceName, String, Nullable<Int32>, CallSettings)

BigtableInstanceAdminClient.ListAppProfilesAsync(InstanceName, String, Nullable<Int32>, CallSettings)

BigtableInstanceAdminClient.UpdateAppProfileAsync(UpdateAppProfileRequest, CancellationToken)

BigtableInstanceAdminClient.PollOnceUpdateAppProfile(String, CallSettings)

BigtableInstanceAdminClient.PollOnceUpdateAppProfileAsync(String, CallSettings)

BigtableInstanceAdminClient.UpdateAppProfile(AppProfile, FieldMask, CallSettings)

BigtableInstanceAdminClient.UpdateAppProfileAsync(AppProfile, FieldMask, CallSettings)

BigtableInstanceAdminClient.UpdateAppProfileAsync(AppProfile, FieldMask, CancellationToken)

BigtableInstanceAdminClient.DeleteAppProfileAsync(DeleteAppProfileRequest, CancellationToken)

BigtableInstanceAdminClient.DeleteAppProfile(String, CallSettings)

BigtableInstanceAdminClient.DeleteAppProfileAsync(String, CallSettings)

BigtableInstanceAdminClient.DeleteAppProfileAsync(String, CancellationToken)

BigtableInstanceAdminClient.DeleteAppProfile(AppProfileName, CallSettings)

BigtableInstanceAdminClient.DeleteAppProfileAsync(AppProfileName, CallSettings)

BigtableInstanceAdminClient.DeleteAppProfileAsync(AppProfileName, CancellationToken)

BigtableInstanceAdminClient.GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

BigtableInstanceAdminClient.GetIamPolicy(String, CallSettings)

BigtableInstanceAdminClient.GetIamPolicyAsync(String, CallSettings)

BigtableInstanceAdminClient.GetIamPolicyAsync(String, CancellationToken)

BigtableInstanceAdminClient.GetIamPolicy(IResourceName, CallSettings)

BigtableInstanceAdminClient.GetIamPolicyAsync(IResourceName, CallSettings)

BigtableInstanceAdminClient.GetIamPolicyAsync(IResourceName, CancellationToken)

BigtableInstanceAdminClient.SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

BigtableInstanceAdminClient.SetIamPolicy(String, Policy, CallSettings)

BigtableInstanceAdminClient.SetIamPolicyAsync(String, Policy, CallSettings)

BigtableInstanceAdminClient.SetIamPolicyAsync(String, Policy, CancellationToken)

BigtableInstanceAdminClient.SetIamPolicy(IResourceName, Policy, CallSettings)

BigtableInstanceAdminClient.SetIamPolicyAsync(IResourceName, Policy, CallSettings)

BigtableInstanceAdminClient.SetIamPolicyAsync(IResourceName, Policy, CancellationToken)

BigtableInstanceAdminClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

BigtableInstanceAdminClient.TestIamPermissions(String, IEnumerable<String>, CallSettings)

BigtableInstanceAdminClient.TestIamPermissionsAsync(String, IEnumerable<String>, CallSettings)

BigtableInstanceAdminClient.TestIamPermissionsAsync(String, IEnumerable<String>, CancellationToken)

BigtableInstanceAdminClient.TestIamPermissions(IResourceName, IEnumerable<String>, CallSettings)

BigtableInstanceAdminClient.TestIamPermissionsAsync(IResourceName, IEnumerable<String>, CallSettings)

BigtableInstanceAdminClient.TestIamPermissionsAsync(IResourceName, IEnumerable<String>, CancellationToken)

BigtableInstanceAdminClient.ListHotTablets(String, String, Nullable<Int32>, CallSettings)

BigtableInstanceAdminClient.ListHotTabletsAsync(String, String, Nullable<Int32>, CallSettings)

BigtableInstanceAdminClient.ListHotTablets(ClusterName, String, Nullable<Int32>, CallSettings)

BigtableInstanceAdminClient.ListHotTabletsAsync(ClusterName, String, Nullable<Int32>, CallSettings)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Remarks

Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables.

Constructors

BigtableInstanceAdminClientImpl(BigtableInstanceAdmin.BigtableInstanceAdminClient, BigtableInstanceAdminSettings, ILogger)

public BigtableInstanceAdminClientImpl(BigtableInstanceAdmin.BigtableInstanceAdminClient grpcClient, BigtableInstanceAdminSettings settings, ILogger logger)

Constructs a client wrapper for the BigtableInstanceAdmin service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`BigtableInstanceAdmin.BigtableInstanceAdminClient` The underlying gRPC client.
`settings`	`BigtableInstanceAdminSettings` The base BigtableInstanceAdminSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

CreateClusterOperationsClient

public override OperationsClient CreateClusterOperationsClient { get; }

The long-running operations client for CreateCluster.

Property Value
Type	Description
`OperationsClient`

Overrides

BigtableInstanceAdminClient.CreateClusterOperationsClient

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type	Description
`OperationsClient`

Overrides

BigtableInstanceAdminClient.CreateInstanceOperationsClient

GrpcClient

public override BigtableInstanceAdmin.BigtableInstanceAdminClient GrpcClient { get; }

The underlying gRPC BigtableInstanceAdmin client

Property Value
Type	Description
`BigtableInstanceAdmin.BigtableInstanceAdminClient`

Overrides

BigtableInstanceAdminClient.GrpcClient

PartialUpdateClusterOperationsClient

public override OperationsClient PartialUpdateClusterOperationsClient { get; }

The long-running operations client for PartialUpdateCluster.

Property Value
Type	Description
`OperationsClient`

Overrides

BigtableInstanceAdminClient.PartialUpdateClusterOperationsClient

PartialUpdateInstanceOperationsClient

public override OperationsClient PartialUpdateInstanceOperationsClient { get; }

The long-running operations client for PartialUpdateInstance.

Property Value
Type	Description
`OperationsClient`

Overrides

BigtableInstanceAdminClient.PartialUpdateInstanceOperationsClient

UpdateAppProfileOperationsClient

public override OperationsClient UpdateAppProfileOperationsClient { get; }

The long-running operations client for UpdateAppProfile.

Property Value
Type	Description
`OperationsClient`

Overrides

BigtableInstanceAdminClient.UpdateAppProfileOperationsClient

UpdateClusterOperationsClient

public override OperationsClient UpdateClusterOperationsClient { get; }

The long-running operations client for UpdateCluster.

Property Value
Type	Description
`OperationsClient`

Overrides

BigtableInstanceAdminClient.UpdateClusterOperationsClient

Methods

CreateAppProfile(CreateAppProfileRequest, CallSettings)

public override AppProfile CreateAppProfile(CreateAppProfileRequest request, CallSettings callSettings = null)

Creates an app profile within an instance.

Parameters
Name	Description
`request`	`CreateAppProfileRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`AppProfile`	The RPC response.

Overrides

BigtableInstanceAdminClient.CreateAppProfile(CreateAppProfileRequest, CallSettings)

CreateAppProfileAsync(CreateAppProfileRequest, CallSettings)

public override Task<AppProfile> CreateAppProfileAsync(CreateAppProfileRequest request, CallSettings callSettings = null)

Creates an app profile within an instance.

Parameters
Name	Description
`request`	`CreateAppProfileRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<AppProfile>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.CreateAppProfileAsync(CreateAppProfileRequest, CallSettings)

CreateCluster(CreateClusterRequest, CallSettings)

public override Operation<Cluster, CreateClusterMetadata> CreateCluster(CreateClusterRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Cluster, CreateClusterMetadata>`	The RPC response.

Overrides

BigtableInstanceAdminClient.CreateCluster(CreateClusterRequest, CallSettings)

CreateClusterAsync(CreateClusterRequest, CallSettings)

public override async Task<Operation<Cluster, CreateClusterMetadata>> CreateClusterAsync(CreateClusterRequest request, CallSettings callSettings = null)

Creates a cluster within an instance.

Parameters
Name	Description
`request`	`CreateClusterRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Cluster, CreateClusterMetadata>>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.CreateClusterAsync(CreateClusterRequest, CallSettings)

CreateInstance(CreateInstanceRequest, CallSettings)

public override Operation<Instance, CreateInstanceMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)

Create an instance within a project.

Parameters
Name	Description
`request`	`CreateInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Instance, CreateInstanceMetadata>`	The RPC response.

Overrides

BigtableInstanceAdminClient.CreateInstance(CreateInstanceRequest, CallSettings)

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

public override async Task<Operation<Instance, CreateInstanceMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CallSettings callSettings = null)

Create an instance within a project.

Parameters
Name	Description
`request`	`CreateInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Instance, CreateInstanceMetadata>>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.CreateInstanceAsync(CreateInstanceRequest, CallSettings)

DeleteAppProfile(DeleteAppProfileRequest, CallSettings)

public override void DeleteAppProfile(DeleteAppProfileRequest request, CallSettings callSettings = null)

Deletes an app profile from an instance.

Parameters
Name	Description
`request`	`DeleteAppProfileRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

BigtableInstanceAdminClient.DeleteAppProfile(DeleteAppProfileRequest, CallSettings)

DeleteAppProfileAsync(DeleteAppProfileRequest, CallSettings)

public override Task DeleteAppProfileAsync(DeleteAppProfileRequest request, CallSettings callSettings = null)

Deletes an app profile from an instance.

Parameters
Name	Description
`request`	`DeleteAppProfileRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.DeleteAppProfileAsync(DeleteAppProfileRequest, CallSettings)

DeleteCluster(DeleteClusterRequest, CallSettings)

public override void DeleteCluster(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a cluster from an instance.

Parameters
Name	Description
`request`	`DeleteClusterRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

BigtableInstanceAdminClient.DeleteCluster(DeleteClusterRequest, CallSettings)

DeleteClusterAsync(DeleteClusterRequest, CallSettings)

public override Task DeleteClusterAsync(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a cluster from an instance.

Parameters
Name	Description
`request`	`DeleteClusterRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.DeleteClusterAsync(DeleteClusterRequest, CallSettings)

DeleteInstance(DeleteInstanceRequest, CallSettings)

public override void DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)

Delete an instance from a project.

Parameters
Name	Description
`request`	`DeleteInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

BigtableInstanceAdminClient.DeleteInstance(DeleteInstanceRequest, CallSettings)

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

public override Task DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)

Delete an instance from a project.

Parameters
Name	Description
`request`	`DeleteInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

GetAppProfile(GetAppProfileRequest, CallSettings)

public override AppProfile GetAppProfile(GetAppProfileRequest request, CallSettings callSettings = null)

Gets information about an app profile.

Parameters
Name	Description
`request`	`GetAppProfileRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`AppProfile`	The RPC response.

Overrides

BigtableInstanceAdminClient.GetAppProfile(GetAppProfileRequest, CallSettings)

GetAppProfileAsync(GetAppProfileRequest, CallSettings)

public override Task<AppProfile> GetAppProfileAsync(GetAppProfileRequest request, CallSettings callSettings = null)

Gets information about an app profile.

Parameters
Name	Description
`request`	`GetAppProfileRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<AppProfile>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.GetAppProfileAsync(GetAppProfileRequest, CallSettings)

GetCluster(GetClusterRequest, CallSettings)

public override Cluster GetCluster(GetClusterRequest request, CallSettings callSettings = null)

Gets information about a cluster.

Parameters
Name	Description
`request`	`GetClusterRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Cluster`	The RPC response.

Overrides

BigtableInstanceAdminClient.GetCluster(GetClusterRequest, CallSettings)

GetClusterAsync(GetClusterRequest, CallSettings)

public override Task<Cluster> GetClusterAsync(GetClusterRequest request, CallSettings callSettings = null)

Gets information about a cluster.

Parameters
Name	Description
`request`	`GetClusterRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Cluster>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.GetClusterAsync(GetClusterRequest, CallSettings)

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Policy`	The RPC response.

Overrides

BigtableInstanceAdminClient.GetIamPolicy(GetIamPolicyRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Policy>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

GetInstance(GetInstanceRequest, CallSettings)

public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)

Gets information about an instance.

Parameters
Name	Description
`request`	`GetInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Instance`	The RPC response.

Overrides

BigtableInstanceAdminClient.GetInstance(GetInstanceRequest, CallSettings)

GetInstanceAsync(GetInstanceRequest, CallSettings)

public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)

Gets information about an instance.

Parameters
Name	Description
`request`	`GetInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Instance>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.GetInstanceAsync(GetInstanceRequest, CallSettings)

ListAppProfiles(ListAppProfilesRequest, CallSettings)

public override PagedEnumerable<ListAppProfilesResponse, AppProfile> ListAppProfiles(ListAppProfilesRequest request, CallSettings callSettings = null)

Lists information about app profiles in an instance.

Parameters
Name	Description
`request`	`ListAppProfilesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListAppProfilesResponse, AppProfile>`	A pageable sequence of AppProfile resources.

Overrides

BigtableInstanceAdminClient.ListAppProfiles(ListAppProfilesRequest, CallSettings)

ListAppProfilesAsync(ListAppProfilesRequest, CallSettings)

public override PagedAsyncEnumerable<ListAppProfilesResponse, AppProfile> ListAppProfilesAsync(ListAppProfilesRequest request, CallSettings callSettings = null)

Lists information about app profiles in an instance.

Parameters
Name	Description
`request`	`ListAppProfilesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListAppProfilesResponse, AppProfile>`	A pageable asynchronous sequence of AppProfile resources.

Overrides

BigtableInstanceAdminClient.ListAppProfilesAsync(ListAppProfilesRequest, CallSettings)

ListClusters(ListClustersRequest, CallSettings)

public override ListClustersResponse ListClusters(ListClustersRequest request, CallSettings callSettings = null)

Lists information about clusters in an instance.

Parameters
Name	Description
`request`	`ListClustersRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ListClustersResponse`	The RPC response.

Overrides

BigtableInstanceAdminClient.ListClusters(ListClustersRequest, CallSettings)

ListClustersAsync(ListClustersRequest, CallSettings)

public override Task<ListClustersResponse> ListClustersAsync(ListClustersRequest request, CallSettings callSettings = null)

Lists information about clusters in an instance.

Parameters
Name	Description
`request`	`ListClustersRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<ListClustersResponse>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.ListClustersAsync(ListClustersRequest, CallSettings)

ListHotTablets(ListHotTabletsRequest, CallSettings)

public override PagedEnumerable<ListHotTabletsResponse, HotTablet> ListHotTablets(ListHotTabletsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListHotTabletsResponse, HotTablet>`	A pageable sequence of HotTablet resources.

Overrides

BigtableInstanceAdminClient.ListHotTablets(ListHotTabletsRequest, CallSettings)

ListHotTabletsAsync(ListHotTabletsRequest, CallSettings)

public override PagedAsyncEnumerable<ListHotTabletsResponse, HotTablet> ListHotTabletsAsync(ListHotTabletsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListHotTabletsResponse, HotTablet>`	A pageable asynchronous sequence of HotTablet resources.

Overrides

BigtableInstanceAdminClient.ListHotTabletsAsync(ListHotTabletsRequest, CallSettings)

ListInstances(ListInstancesRequest, CallSettings)

public override ListInstancesResponse ListInstances(ListInstancesRequest request, CallSettings callSettings = null)

Lists information about instances in a project.

Parameters
Name	Description
`request`	`ListInstancesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ListInstancesResponse`	The RPC response.

Overrides

BigtableInstanceAdminClient.ListInstances(ListInstancesRequest, CallSettings)

ListInstancesAsync(ListInstancesRequest, CallSettings)

public override Task<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)

Lists information about instances in a project.

Parameters
Name	Description
`request`	`ListInstancesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<ListInstancesResponse>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.ListInstancesAsync(ListInstancesRequest, CallSettings)

PartialUpdateCluster(PartialUpdateClusterRequest, CallSettings)

public override Operation<Cluster, PartialUpdateClusterMetadata> PartialUpdateCluster(PartialUpdateClusterRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Cluster, PartialUpdateClusterMetadata>`	The RPC response.

Overrides

BigtableInstanceAdminClient.PartialUpdateCluster(PartialUpdateClusterRequest, CallSettings)

PartialUpdateClusterAsync(PartialUpdateClusterRequest, CallSettings)

public override async Task<Operation<Cluster, PartialUpdateClusterMetadata>> PartialUpdateClusterAsync(PartialUpdateClusterRequest request, CallSettings callSettings = null)

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Cluster, PartialUpdateClusterMetadata>>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.PartialUpdateClusterAsync(PartialUpdateClusterRequest, CallSettings)

PartialUpdateInstance(PartialUpdateInstanceRequest, CallSettings)

public override Operation<Instance, UpdateInstanceMetadata> PartialUpdateInstance(PartialUpdateInstanceRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Instance, UpdateInstanceMetadata>`	The RPC response.

Overrides

BigtableInstanceAdminClient.PartialUpdateInstance(PartialUpdateInstanceRequest, CallSettings)

PartialUpdateInstanceAsync(PartialUpdateInstanceRequest, CallSettings)

public override async Task<Operation<Instance, UpdateInstanceMetadata>> PartialUpdateInstanceAsync(PartialUpdateInstanceRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Instance, UpdateInstanceMetadata>>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.PartialUpdateInstanceAsync(PartialUpdateInstanceRequest, CallSettings)

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Policy`	The RPC response.

Overrides

BigtableInstanceAdminClient.SetIamPolicy(SetIamPolicyRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Policy>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TestIamPermissionsResponse`	The RPC response.

Overrides

BigtableInstanceAdminClient.TestIamPermissions(TestIamPermissionsRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<TestIamPermissionsResponse>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

UpdateAppProfile(UpdateAppProfileRequest, CallSettings)

public override Operation<AppProfile, UpdateAppProfileMetadata> UpdateAppProfile(UpdateAppProfileRequest request, CallSettings callSettings = null)

Updates an app profile within an instance.

Parameters
Name	Description
`request`	`UpdateAppProfileRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<AppProfile, UpdateAppProfileMetadata>`	The RPC response.

Overrides

BigtableInstanceAdminClient.UpdateAppProfile(UpdateAppProfileRequest, CallSettings)

UpdateAppProfileAsync(UpdateAppProfileRequest, CallSettings)

public override async Task<Operation<AppProfile, UpdateAppProfileMetadata>> UpdateAppProfileAsync(UpdateAppProfileRequest request, CallSettings callSettings = null)

Updates an app profile within an instance.

Parameters
Name	Description
`request`	`UpdateAppProfileRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<AppProfile, UpdateAppProfileMetadata>>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.UpdateAppProfileAsync(UpdateAppProfileRequest, CallSettings)

UpdateCluster(Cluster, CallSettings)

public override Operation<Cluster, UpdateClusterMetadata> UpdateCluster(Cluster request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Cluster, UpdateClusterMetadata>`	The RPC response.

Overrides

BigtableInstanceAdminClient.UpdateCluster(Cluster, CallSettings)

UpdateClusterAsync(Cluster, CallSettings)

public override async Task<Operation<Cluster, UpdateClusterMetadata>> UpdateClusterAsync(Cluster request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Cluster, UpdateClusterMetadata>>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.UpdateClusterAsync(Cluster, CallSettings)

UpdateInstance(Instance, CallSettings)

public override Instance UpdateInstance(Instance request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Instance`	The RPC response.

Overrides

BigtableInstanceAdminClient.UpdateInstance(Instance, CallSettings)

UpdateInstanceAsync(Instance, CallSettings)

public override Task<Instance> UpdateInstanceAsync(Instance request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Instance>`	A Task containing the RPC response.

Overrides

BigtableInstanceAdminClient.UpdateInstanceAsync(Instance, CallSettings)