public sealed class BigtableInstanceAdminClientImpl : BigtableInstanceAdminClient
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(BigtableInstanceAdmin.BigtableInstanceAdminClient, BigtableInstanceAdminSettings)
public BigtableInstanceAdminClientImpl(BigtableInstanceAdmin.BigtableInstanceAdminClient grpcClient, BigtableInstanceAdminSettings settings)
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. |
Properties
CreateClusterOperationsClient
public override OperationsClient CreateClusterOperationsClient { get; }
The long-running operations client for CreateCluster
.
Property Value | |
---|---|
Type | Description |
Google.LongRunning.OperationsClient |
CreateInstanceOperationsClient
public override OperationsClient CreateInstanceOperationsClient { get; }
The long-running operations client for CreateInstance
.
Property Value | |
---|---|
Type | Description |
Google.LongRunning.OperationsClient |
GrpcClient
public override BigtableInstanceAdmin.BigtableInstanceAdminClient GrpcClient { get; }
The underlying gRPC BigtableInstanceAdmin client
Property Value | |
---|---|
Type | Description |
BigtableInstanceAdmin.BigtableInstanceAdminClient |
PartialUpdateInstanceOperationsClient
public override OperationsClient PartialUpdateInstanceOperationsClient { get; }
The long-running operations client for PartialUpdateInstance
.
Property Value | |
---|---|
Type | Description |
Google.LongRunning.OperationsClient |
UpdateAppProfileOperationsClient
public override OperationsClient UpdateAppProfileOperationsClient { get; }
The long-running operations client for UpdateAppProfile
.
Property Value | |
---|---|
Type | Description |
Google.LongRunning.OperationsClient |
UpdateClusterOperationsClient
public override OperationsClient UpdateClusterOperationsClient { get; }
The long-running operations client for UpdateCluster
.
Property Value | |
---|---|
Type | Description |
Google.LongRunning.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 |
Task<AppProfile> | 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.
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 |
Google.LongRunning.Operation<Cluster, CreateClusterMetadata> | The RPC response. |
CreateClusterAsync(CreateClusterRequest, CallSettings)
public override 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<Google.LongRunning.Operation<Cluster, CreateClusterMetadata>> | 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.
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 |
Google.LongRunning.Operation<Instance, CreateInstanceMetadata> | The RPC response. |
CreateInstanceAsync(CreateInstanceRequest, CallSettings)
public override 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<Google.LongRunning.Operation<Instance, CreateInstanceMetadata>> | 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 |
Task<AppProfile> | 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 |
Task<Cluster> | 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 | Google.Cloud.Iam.V1.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 |
Google.Cloud.Iam.V1.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 | Google.Cloud.Iam.V1.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<Google.Cloud.Iam.V1.Policy> | 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 |
Task<Instance> | 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 |
PagedEnumerable<ListAppProfilesResponse, AppProfile> | 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 |
PagedAsyncEnumerable<ListAppProfilesResponse, AppProfile> | 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 |
Task<ListClustersResponse> | A Task containing the RPC response. |
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. |
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. |
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 |
Google.LongRunning.Operation<Instance, UpdateInstanceMetadata> | The RPC response. |
PartialUpdateInstanceAsync(PartialUpdateInstanceRequest, CallSettings)
public override 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<Google.LongRunning.Operation<Instance, UpdateInstanceMetadata>> | A Task containing the RPC response. |
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 | Google.Cloud.Iam.V1.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 |
Google.Cloud.Iam.V1.Policy | The RPC response. |
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 | Google.Cloud.Iam.V1.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<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
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 | Google.Cloud.Iam.V1.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 |
Google.Cloud.Iam.V1.TestIamPermissionsResponse | The RPC response. |
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 | Google.Cloud.Iam.V1.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<Google.Cloud.Iam.V1.TestIamPermissionsResponse> | A Task containing the RPC response. |
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 |
Google.LongRunning.Operation<AppProfile, UpdateAppProfileMetadata> | The RPC response. |
UpdateAppProfileAsync(UpdateAppProfileRequest, CallSettings)
public override 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<Google.LongRunning.Operation<AppProfile, UpdateAppProfileMetadata>> | A Task containing the RPC response. |
UpdateCluster(Cluster, CallSettings)
public override Operation<Cluster, UpdateClusterMetadata> UpdateCluster(Cluster request, CallSettings callSettings = null)
Updates a cluster within an instance.
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 |
Google.LongRunning.Operation<Cluster, UpdateClusterMetadata> | The RPC response. |
UpdateClusterAsync(Cluster, CallSettings)
public override Task<Operation<Cluster, UpdateClusterMetadata>> UpdateClusterAsync(Cluster request, CallSettings callSettings = null)
Updates a cluster within an instance.
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<Google.LongRunning.Operation<Cluster, UpdateClusterMetadata>> | A Task containing the RPC response. |
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. |
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. |