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.
Namespace
Google.Cloud.Bigtable.Admin.V2Assembly
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(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 | BigtableInstanceAdminBigtableInstanceAdminClient 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 |
CreateInstanceOperationsClient
public override OperationsClient CreateInstanceOperationsClient { get; }
The long-running operations client for CreateInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override BigtableInstanceAdmin.BigtableInstanceAdminClient GrpcClient { get; }
The underlying gRPC BigtableInstanceAdmin client
Property Value | |
---|---|
Type | Description |
BigtableInstanceAdminBigtableInstanceAdminClient |
PartialUpdateClusterOperationsClient
public override OperationsClient PartialUpdateClusterOperationsClient { get; }
The long-running operations client for PartialUpdateCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
PartialUpdateInstanceOperationsClient
public override OperationsClient PartialUpdateInstanceOperationsClient { get; }
The long-running operations client for PartialUpdateInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateAppProfileOperationsClient
public override OperationsClient UpdateAppProfileOperationsClient { get; }
The long-running operations client for UpdateAppProfile
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateClusterOperationsClient
public override OperationsClient UpdateClusterOperationsClient { get; }
The long-running operations client for UpdateCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
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. |
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 |
TaskAppProfile | A Task containing the RPC response. |
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 |
OperationClusterCreateClusterMetadata | The RPC response. |
CreateClusterAsync(CreateClusterRequest, CallSettings)
public override Task<Operation<Cluster, CreateClusterMetadata>> CreateClusterAsync(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 |
TaskOperationClusterCreateClusterMetadata | A Task containing the RPC response. |
CreateInstance(CreateInstanceRequest, CallSettings)
public override Operation<Instance, CreateInstanceMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationInstanceCreateInstanceMetadata | The RPC response. |
CreateInstanceAsync(CreateInstanceRequest, CallSettings)
public override Task<Operation<Instance, CreateInstanceMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationInstanceCreateInstanceMetadata | A Task containing the RPC response. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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 |
TaskAppProfile | A Task containing the RPC response. |
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. |
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 |
TaskCluster | A Task containing the RPC response. |
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. |
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 |
TaskPolicy | A Task containing the RPC response. |
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. |
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 |
TaskInstance | A Task containing the RPC response. |
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 |
PagedEnumerableListAppProfilesResponseAppProfile | A pageable sequence of AppProfile resources. |
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 |
PagedAsyncEnumerableListAppProfilesResponseAppProfile | A pageable asynchronous sequence of AppProfile resources. |
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. |
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 |
TaskListClustersResponse | A Task containing the RPC response. |
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 |
PagedEnumerableListHotTabletsResponseHotTablet | A pageable sequenc |