public class BigtableInstanceAdminClient : ClientBase<BigtableInstanceAdmin.BigtableInstanceAdminClient>Client for BigtableInstanceAdmin
Inheritance
Object > ClientBase > ClientBase<BigtableInstanceAdmin.BigtableInstanceAdminClient> > BigtableInstanceAdmin.BigtableInstanceAdminClientNamespace
Google.Cloud.Bigtable.Admin.V2Assembly
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 |
CallInvokerThe callInvoker to use to make remote calls. |
BigtableInstanceAdminClient(ChannelBase)
public BigtableInstanceAdminClient(ChannelBase channel)Creates a new client for BigtableInstanceAdmin
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
BigtableInstanceAdminClient(ClientBase.ClientBaseConfiguration)
protected BigtableInstanceAdminClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBase.ClientBaseConfigurationThe 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 |
CreateAppProfileRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AppProfile |
The response received from the server. |
CreateAppProfile(CreateAppProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AppProfile CreateAppProfile(CreateAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Creates an app profile within an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAppProfileRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
CreateAppProfileRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<AppProfile> |
The call object. |
CreateAppProfileAsync(CreateAppProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<AppProfile> CreateAppProfileAsync(CreateAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Creates an app profile within an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAppProfileRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<AppProfile> |
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 |
CreateClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateCluster(CreateClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation CreateCluster(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
CreateClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
CreateClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
The call object. |
CreateClusterAsync(CreateClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
CreateClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
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 |
CreateInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateInstance(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
CreateInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
CreateInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
The call object. |
CreateInstanceAsync(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
CreateInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
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 |
Operations.OperationsClient |
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 |
DeleteAppProfileRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteAppProfile(DeleteAppProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Empty DeleteAppProfile(DeleteAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Deletes an app profile from an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAppProfileRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
DeleteAppProfileRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Empty> |
The call object. |
DeleteAppProfileAsync(DeleteAppProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteAppProfileAsync(DeleteAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Deletes an app profile from an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAppProfileRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Empty> |
The call object. |
DeleteCluster(DeleteClusterRequest, CallOptions)
public virtual Empty DeleteCluster(DeleteClusterRequest request, CallOptions options)Deletes a cluster from an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteCluster(DeleteClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Empty DeleteCluster(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Deletes a cluster from an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
DeleteClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Empty> |
The call object. |
DeleteClusterAsync(DeleteClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteClusterAsync(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Deletes a cluster from an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Empty> |
The call object. |
DeleteInstance(DeleteInstanceRequest, CallOptions)
public virtual Empty DeleteInstance(DeleteInstanceRequest request, CallOptions options)Delete an instance from a project.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeleteInstance(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Empty DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Delete an instance from a project.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
DeleteInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Empty> |
The call object. |
DeleteInstanceAsync(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Delete an instance from a project.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Empty> |
The call object. |
GetAppProfile(GetAppProfileRequest, CallOptions)
public virtual AppProfile GetAppProfile(GetAppProfileRequest request, CallOptions options)Gets information about an app profile.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAppProfileRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AppProfile |
The response received from the server. |
GetAppProfile(GetAppProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AppProfile GetAppProfile(GetAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Gets information about an app profile.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAppProfileRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
GetAppProfileRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<AppProfile> |
The call object. |
GetAppProfileAsync(GetAppProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<AppProfile> GetAppProfileAsync(GetAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Gets information about an app profile.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAppProfileRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<AppProfile> |
The call object. |
GetCluster(GetClusterRequest, CallOptions)
public virtual Cluster GetCluster(GetClusterRequest request, CallOptions options)Gets information about a cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Cluster |
The response received from the server. |
GetCluster(GetClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Cluster GetCluster(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Gets information about a cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
GetClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Cluster> |
The call object. |
GetClusterAsync(GetClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Cluster> GetClusterAsync(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Gets information about a cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Cluster> |
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 |
GetIamPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Policy |
The response received from the server. |
GetIamPolicy(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
GetIamPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
GetIamPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Policy> |
The call object. |
GetIamPolicyAsync(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
GetIamPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Policy> |
The call object. |
GetInstance(GetInstanceRequest, CallOptions)
public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)Gets information about an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Instance |
The response received from the server. |
GetInstance(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Gets information about an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
GetInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Instance> |
The call object. |
GetInstanceAsync(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Gets information about an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Instance> |
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 |
ListAppProfilesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListAppProfilesResponse |
The response received from the server. |
ListAppProfiles(ListAppProfilesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListAppProfilesResponse ListAppProfiles(ListAppProfilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Lists information about app profiles in an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAppProfilesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
ListAppProfilesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListAppProfilesResponse> |
The call object. |
ListAppProfilesAsync(ListAppProfilesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListAppProfilesResponse> ListAppProfilesAsync(ListAppProfilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Lists information about app profiles in an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAppProfilesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListAppProfilesResponse> |
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 |
ListClustersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListClustersResponse |
The response received from the server. |
ListClusters(ListClustersRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListClustersResponse ListClusters(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Lists information about clusters in an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
ListClustersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
ListClustersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListClustersResponse> |
The call object. |
ListClustersAsync(ListClustersRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListClustersResponse> ListClustersAsync(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Lists information about clusters in an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
ListClustersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListClustersResponse> |
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 |
ListHotTabletsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListHotTabletsResponse |
The response received from the server. |
ListHotTablets(ListHotTabletsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListHotTabletsResponse ListHotTablets(ListHotTabletsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.
| Parameters | |
|---|---|
| Name | Description |
request |
ListHotTabletsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
ListHotTabletsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListHotTabletsResponse> |
The call object. |
ListHotTabletsAsync(ListHotTabletsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListHotTabletsResponse> ListHotTabletsAsync(ListHotTabletsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.
| Parameters | |
|---|---|
| Name | Description |
request |
ListHotTabletsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListHotTabletsResponse> |
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 |
ListInstancesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListInstancesResponse |
The response received from the server. |
ListInstances(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Lists information about instances in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListInstancesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
ListInstancesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListInstancesResponse> |
The call object. |
ListInstancesAsync(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Lists information about instances in a project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListInstancesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListInstancesResponse> |
The call object. |
NewInstance(ClientBase.ClientBaseConfiguration)
protected override BigtableInstanceAdmin.BigtableInstanceAdminClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBase.ClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
BigtableInstanceAdmin.BigtableInstanceAdminClient |
|
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 |
PartialUpdateClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
PartialUpdateCluster(PartialUpdateClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation PartialUpdateCluster(PartialUpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
PartialUpdateClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
PartialUpdateClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
The call object. |
PartialUpdateClusterAsync(PartialUpdateClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> PartialUpdateClusterAsync(PartialUpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
PartialUpdateClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
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 |
PartialUpdateInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
PartialUpdateInstance(PartialUpdateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation PartialUpdateInstance(PartialUpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
PartialUpdateInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
PartialUpdateInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
The call object. |
PartialUpdateInstanceAsync(PartialUpdateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> PartialUpdateInstanceAsync(PartialUpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
PartialUpdateInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
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 |
SetIamPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Policy |
The response received from the server. |
SetIamPolicy(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Sets the access control policy on an instance resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
request |
SetIamPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
SetIamPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Policy> |
The call object. |
SetIamPolicyAsync(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Sets the access control policy on an instance resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
request |
SetIamPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Policy> |
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 |
TestIamPermissionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
TestIamPermissionsResponse |
The response received from the server. |
TestIamPermissions(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Returns permissions that the caller has on the specified instance resource.
| Parameters | |
|---|---|
| Name | Description |
request |
TestIamPermissionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
TestIamPermissionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<TestIamPermissionsResponse> |
The call object. |
TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Returns permissions that the caller has on the specified instance resource.
| Parameters | |
|---|---|
| Name | Description |
request |
TestIamPermissionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<TestIamPermissionsResponse> |
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 |
UpdateAppProfileRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateAppProfile(UpdateAppProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation UpdateAppProfile(UpdateAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Updates an app profile within an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAppProfileRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
UpdateAppProfileRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
The call object. |
UpdateAppProfileAsync(UpdateAppProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateAppProfileAsync(UpdateAppProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Updates an app profile within an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAppProfileRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
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 |
ClusterThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateCluster(Cluster, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation UpdateCluster(Cluster request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
ClusterThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
ClusterThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
The call object. |
UpdateClusterAsync(Cluster, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateClusterAsync(Cluster request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
ClusterThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
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 |
InstanceThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Instance |
The response received from the server. |
UpdateInstance(Instance, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Instance UpdateInstance(Instance request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
InstanceThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
InstanceThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Instance> |
The call object. |
UpdateInstanceAsync(Instance, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Instance> UpdateInstanceAsync(Instance request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))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 |
InstanceThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Instance> |
The call object. |