public sealed class BigtableInstanceAdminClientImpl : BigtableInstanceAdminClientReference 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 | BigtableInstanceAdminBigtableInstanceAdminClientThe underlying gRPC client. |
settings | BigtableInstanceAdminSettingsThe base BigtableInstanceAdminSettings used within this client. |
logger | ILoggerOptional 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 | CreateAppProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | CreateAppProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | CreateClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | CreateClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | CreateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | CreateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | DeleteAppProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | DeleteAppProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | DeleteClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | DeleteClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | DeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | DeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | GetAppProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | GetAppProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | GetClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | GetClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | GetInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | GetInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | ListAppProfilesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | ListAppProfilesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | ListClustersRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | ListClustersRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | ListHotTabletsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListHotTabletsResponseHotTablet | A pageable sequence of HotTablet resources. |
ListHotTabletsAsync(ListHotTabletsRequest, CallSettings)
public override PagedAsyncEnumerable<ListHotTabletsResponse, HotTablet> ListHotTabletsAsync(ListHotTabletsRequest request, CallSettings callSettings = null)Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.
| Parameters | |
|---|---|
| Name | Description |
request | ListHotTabletsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListHotTabletsResponseHotTablet | A pageable asynchronous sequence of HotTablet resources. |
ListInstances(ListInstancesRequest, CallSettings)
public override ListInstancesResponse ListInstances(ListInstancesRequest request, CallSettings callSettings = null)Lists information about instances in a project.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | ListInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskListInstancesResponse | A Task containing the RPC response. |
PartialUpdateCluster(PartialUpdateClusterRequest, CallSettings)
public override Operation<Cluster, PartialUpdateClusterMetadata> PartialUpdateCluster(PartialUpdateClusterRequest request, CallSettings callSettings = null)Partially updates a cluster within a project. This method is the preferred way to update a Cluster.
To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.
To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.
| Parameters | |
|---|---|
| Name | Description |
request | PartialUpdateClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationClusterPartialUpdateClusterMetadata | The RPC response. |
PartialUpdateClusterAsync(PartialUpdateClusterRequest, CallSettings)
public override Task<Operation<Cluster, PartialUpdateClusterMetadata>> PartialUpdateClusterAsync(PartialUpdateClusterRequest request, CallSettings callSettings = null)Partially updates a cluster within a project. This method is the preferred way to update a Cluster.
To 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 object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationClusterPartialUpdateClusterMetadata | 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 | PartialUpdateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationInstanceUpdateInstanceMetadata | 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 | PartialUpdateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationInstanceUpdateInstanceMetadata | 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 | SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
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 | SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | 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 | TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
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 | TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestIamPermissionsResponse | 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 | UpdateAppProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAppProfileUpdateAppProfileMetadata | 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 | UpdateAppProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAppProfileUpdateAppProfileMetadata | 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.
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 object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationClusterUpdateClusterMetadata | The RPC response. |
UpdateClusterAsync(Cluster, CallSettings)
public override Task<Operation<Cluster, UpdateClusterMetadata>> UpdateClusterAsync(Cluster request, CallSettings callSettings = null)Updates a cluster within an instance.
Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.
| Parameters | |
|---|---|
| Name | Description |
request | ClusterThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationClusterUpdateClusterMetadata | 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 | InstanceThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | InstanceThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskInstance | A Task containing the RPC response. |