Class BdsClient
Service client instance for Bds.
Implements
Inherited Members
Namespace: Oci.BdsService
Assembly: OCI.DotNetSDK.Bds.dll
Syntax
public class BdsClient : RegionalClientBase, IDisposable
Constructors
BdsClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public BdsClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public BdsPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
BdsPaginators |
Waiters
Declaration
public BdsWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
BdsWaiters |
Methods
ActivateBdsMetastoreConfiguration(ActivateBdsMetastoreConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Activate specified metastore configuration.
Declaration
public Task<ActivateBdsMetastoreConfigurationResponse> ActivateBdsMetastoreConfiguration(ActivateBdsMetastoreConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ActivateBdsMetastoreConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ActivateBdsMetastoreConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ActivateBdsMetastoreConfiguration API.
AddAutoScalingConfiguration(AddAutoScalingConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add an autoscale configuration to the cluster.
Declaration
public Task<AddAutoScalingConfigurationResponse> AddAutoScalingConfiguration(AddAutoScalingConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddAutoScalingConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddAutoScalingConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddAutoScalingConfiguration API.
AddBlockStorage(AddBlockStorageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds block storage to existing worker/compute only worker nodes. The same amount of storage will be added to all worker/compute only worker nodes. No change will be made to storage that is already attached. Block storage cannot be removed.
Declaration
public Task<AddBlockStorageResponse> AddBlockStorage(AddBlockStorageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddBlockStorageRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddBlockStorageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddBlockStorage API.
AddCloudSql(AddCloudSqlRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds Cloud SQL to your cluster. You can use Cloud SQL to query against non-relational data stored in multiple big data sources, including Apache Hive, HDFS, Oracle NoSQL Database, and Apache HBase. Adding Cloud SQL adds a query server node to the cluster and creates cell servers on all the worker nodes in the cluster.
Declaration
public Task<AddCloudSqlResponse> AddCloudSql(AddCloudSqlRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddCloudSqlRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddCloudSqlResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddCloudSql API.
AddKafka(AddKafkaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds Kafka to a cluster.
Declaration
public Task<AddKafkaResponse> AddKafka(AddKafkaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddKafkaRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddKafkaResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddKafka API.
AddMasterNodes(AddMasterNodesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Increases the size (scales out) of a cluster by adding master nodes. The added master nodes will have the same shape and will have the same amount of attached block storage as other master nodes in the cluster.
Declaration
public Task<AddMasterNodesResponse> AddMasterNodes(AddMasterNodesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddMasterNodesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddMasterNodesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddMasterNodes API.
AddUtilityNodes(AddUtilityNodesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Increases the size (scales out) of a cluster by adding utility nodes. The added utility nodes will have the same shape and will have the same amount of attached block storage as other utility nodes in the cluster.
Declaration
public Task<AddUtilityNodesResponse> AddUtilityNodes(AddUtilityNodesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddUtilityNodesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddUtilityNodesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddUtilityNodes API.
AddWorkerNodes(AddWorkerNodesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Increases the size (scales out) a cluster by adding worker nodes(data/compute). The added worker nodes will have the same shape and will have the same amount of attached block storage as other worker nodes in the cluster.
Declaration
public Task<AddWorkerNodesResponse> AddWorkerNodes(AddWorkerNodesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddWorkerNodesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddWorkerNodesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddWorkerNodes API.
BackupNode(BackupNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Takes a backup of of given nodes.
Declaration
public Task<BackupNodeResponse> BackupNode(BackupNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BackupNodeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BackupNodeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BackupNode API.
CertificateServiceInfo(CertificateServiceInfoRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
A list of services and their certificate details.
Declaration
public Task<CertificateServiceInfoResponse> CertificateServiceInfo(CertificateServiceInfoRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CertificateServiceInfoRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CertificateServiceInfoResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CertificateServiceInfo API.
ChangeBdsInstanceCompartment(ChangeBdsInstanceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a Big Data Service cluster into a different compartment.
Declaration
public Task<ChangeBdsInstanceCompartmentResponse> ChangeBdsInstanceCompartment(ChangeBdsInstanceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeBdsInstanceCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeBdsInstanceCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeBdsInstanceCompartment API.
ChangeShape(ChangeShapeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Changes the size of a cluster by scaling up or scaling down the nodes. Nodes are scaled up or down by changing the shapes of all the nodes of the same type to the next larger or smaller shape. The node types are master, utility, worker, and Cloud SQL. Only nodes with VM-STANDARD shapes can be scaled.
Declaration
public Task<ChangeShapeResponse> ChangeShape(ChangeShapeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeShapeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeShapeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeShape API.
CreateBdsApiKey(CreateBdsApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create an API key on behalf of the specified user.
Declaration
public Task<CreateBdsApiKeyResponse> CreateBdsApiKey(CreateBdsApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateBdsApiKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateBdsApiKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateBdsApiKey API.
CreateBdsInstance(CreateBdsInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a Big Data Service cluster.
Declaration
public Task<CreateBdsInstanceResponse> CreateBdsInstance(CreateBdsInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateBdsInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateBdsInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateBdsInstance API.
CreateBdsMetastoreConfiguration(CreateBdsMetastoreConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create and activate external metastore configuration.
Declaration
public Task<CreateBdsMetastoreConfigurationResponse> CreateBdsMetastoreConfiguration(CreateBdsMetastoreConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateBdsMetastoreConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateBdsMetastoreConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateBdsMetastoreConfiguration API.
CreateNodeBackupConfiguration(CreateNodeBackupConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add a node volume backup configuration to the cluster for an indicated node type or node.
Declaration
public Task<CreateNodeBackupConfigurationResponse> CreateNodeBackupConfiguration(CreateNodeBackupConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateNodeBackupConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateNodeBackupConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateNodeBackupConfiguration API.
CreateNodeReplaceConfiguration(CreateNodeReplaceConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add a nodeReplaceConfigurations to the cluster.
Declaration
public Task<CreateNodeReplaceConfigurationResponse> CreateNodeReplaceConfiguration(CreateNodeReplaceConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateNodeReplaceConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateNodeReplaceConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateNodeReplaceConfiguration API.
CreateResourcePrincipalConfiguration(CreateResourcePrincipalConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a resource principal session token configuration.
Declaration
public Task<CreateResourcePrincipalConfigurationResponse> CreateResourcePrincipalConfiguration(CreateResourcePrincipalConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateResourcePrincipalConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateResourcePrincipalConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateResourcePrincipalConfiguration API.
DeleteBdsApiKey(DeleteBdsApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the user's API key represented by the provided ID.
Declaration
public Task<DeleteBdsApiKeyResponse> DeleteBdsApiKey(DeleteBdsApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteBdsApiKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteBdsApiKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteBdsApiKey API.
DeleteBdsInstance(DeleteBdsInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the cluster identified by the given ID.
Declaration
public Task<DeleteBdsInstanceResponse> DeleteBdsInstance(DeleteBdsInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteBdsInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteBdsInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteBdsInstance API.
DeleteBdsMetastoreConfiguration(DeleteBdsMetastoreConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the BDS metastore configuration represented by the provided ID.
Declaration
public Task<DeleteBdsMetastoreConfigurationResponse> DeleteBdsMetastoreConfiguration(DeleteBdsMetastoreConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteBdsMetastoreConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteBdsMetastoreConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteBdsMetastoreConfiguration API.
DeleteNodeBackup(DeleteNodeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the NodeBackup represented by the provided ID.
Declaration
public Task<DeleteNodeBackupResponse> DeleteNodeBackup(DeleteNodeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteNodeBackupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteNodeBackupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteNodeBackup API.
DeleteNodeBackupConfiguration(DeleteNodeBackupConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the NodeBackupConfiguration represented by the provided ID.
Declaration
public Task<DeleteNodeBackupConfigurationResponse> DeleteNodeBackupConfiguration(DeleteNodeBackupConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteNodeBackupConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteNodeBackupConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteNodeBackupConfiguration API.
DisableCertificate(DisableCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Disabling TLS/SSL for various ODH services running on the BDS cluster.
Declaration
public Task<DisableCertificateResponse> DisableCertificate(DisableCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DisableCertificateRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DisableCertificateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DisableCertificate API.
EnableCertificate(EnableCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Configuring TLS/SSL for various ODH services running on the BDS cluster.
Declaration
public Task<EnableCertificateResponse> EnableCertificate(EnableCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
EnableCertificateRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<EnableCertificateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EnableCertificate API.
ExecuteBootstrapScript(ExecuteBootstrapScriptRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Execute bootstrap script.
Declaration
public Task<ExecuteBootstrapScriptResponse> ExecuteBootstrapScript(ExecuteBootstrapScriptRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ExecuteBootstrapScriptRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ExecuteBootstrapScriptResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ExecuteBootstrapScript API.
ForceRefreshResourcePrincipal(ForceRefreshResourcePrincipalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Force Refresh Resource Principal for the cluster.
Declaration
public Task<ForceRefreshResourcePrincipalResponse> ForceRefreshResourcePrincipal(ForceRefreshResourcePrincipalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ForceRefreshResourcePrincipalRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ForceRefreshResourcePrincipalResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ForceRefreshResourcePrincipal API.
GetAutoScalingConfiguration(GetAutoScalingConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns details of the autoscale configuration identified by the given ID.
Declaration
public Task<GetAutoScalingConfigurationResponse> GetAutoScalingConfiguration(GetAutoScalingConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAutoScalingConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAutoScalingConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAutoScalingConfiguration API.
GetBdsApiKey(GetBdsApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the user's API key information for the given ID.
Declaration
public Task<GetBdsApiKeyResponse> GetBdsApiKey(GetBdsApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetBdsApiKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetBdsApiKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetBdsApiKey API.
GetBdsInstance(GetBdsInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns information about the Big Data Service cluster identified by the given ID.
Declaration
public Task<GetBdsInstanceResponse> GetBdsInstance(GetBdsInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetBdsInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetBdsInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetBdsInstance API.
GetBdsMetastoreConfiguration(GetBdsMetastoreConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the BDS Metastore configuration information for the given ID.
Declaration
public Task<GetBdsMetastoreConfigurationResponse> GetBdsMetastoreConfiguration(GetBdsMetastoreConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetBdsMetastoreConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetBdsMetastoreConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetBdsMetastoreConfiguration API.
GetNodeBackup(GetNodeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns details of NodeBackup identified by the given ID.
Declaration
public Task<GetNodeBackupResponse> GetNodeBackup(GetNodeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetNodeBackupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetNodeBackupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetNodeBackup API.
GetNodeBackupConfiguration(GetNodeBackupConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns details of the NodeBackupConfiguration identified by the given ID.
Declaration
public Task<GetNodeBackupConfigurationResponse> GetNodeBackupConfiguration(GetNodeBackupConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetNodeBackupConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetNodeBackupConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetNodeBackupConfiguration API.
GetNodeReplaceConfiguration(GetNodeReplaceConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns details of the nodeReplaceConfiguration identified by the given ID.
Declaration
public Task<GetNodeReplaceConfigurationResponse> GetNodeReplaceConfiguration(GetNodeReplaceConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetNodeReplaceConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetNodeReplaceConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetNodeReplaceConfiguration API.
GetOsPatchDetails(GetOsPatchDetailsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the details of an os patch
Declaration
public Task<GetOsPatchDetailsResponse> GetOsPatchDetails(GetOsPatchDetailsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetOsPatchDetailsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetOsPatchDetailsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetOsPatchDetails API.
GetResourcePrincipalConfiguration(GetResourcePrincipalConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns details of the resourcePrincipalConfiguration identified by the given ID.
Declaration
public Task<GetResourcePrincipalConfigurationResponse> GetResourcePrincipalConfiguration(GetResourcePrincipalConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResourcePrincipalConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetResourcePrincipalConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResourcePrincipalConfiguration API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the status of the work request identified by the given ID.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
InstallOsPatch(InstallOsPatchRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Install an os patch on a cluster
Declaration
public Task<InstallOsPatchResponse> InstallOsPatch(InstallOsPatchRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
InstallOsPatchRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<InstallOsPatchResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use InstallOsPatch API.
InstallPatch(InstallPatchRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Install the specified patch to this cluster.
Declaration
public Task<InstallPatchResponse> InstallPatch(InstallPatchRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
InstallPatchRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<InstallPatchResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use InstallPatch API.
ListAutoScalingConfigurations(ListAutoScalingConfigurationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns information about the autoscaling configurations for a cluster.
Declaration
public Task<ListAutoScalingConfigurationsResponse> ListAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAutoScalingConfigurationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAutoScalingConfigurationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAutoScalingConfigurations API.
ListBdsApiKeys(ListBdsApiKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all API keys associated with this Big Data Service cluster.
Declaration
public Task<ListBdsApiKeysResponse> ListBdsApiKeys(ListBdsApiKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListBdsApiKeysRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListBdsApiKeysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListBdsApiKeys API.
ListBdsInstances(ListBdsInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all Big Data Service clusters in a compartment.
Declaration
public Task<ListBdsInstancesResponse> ListBdsInstances(ListBdsInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListBdsInstancesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListBdsInstancesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListBdsInstances API.
ListBdsMetastoreConfigurations(ListBdsMetastoreConfigurationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of metastore configurations ssociated with this Big Data Service cluster.
Declaration
public Task<ListBdsMetastoreConfigurationsResponse> ListBdsMetastoreConfigurations(ListBdsMetastoreConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListBdsMetastoreConfigurationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListBdsMetastoreConfigurationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListBdsMetastoreConfigurations API.
ListNodeBackupConfigurations(ListNodeBackupConfigurationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns information about the NodeBackupConfigurations.
Declaration
public Task<ListNodeBackupConfigurationsResponse> ListNodeBackupConfigurations(ListNodeBackupConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListNodeBackupConfigurationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListNodeBackupConfigurationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListNodeBackupConfigurations API.
ListNodeBackups(ListNodeBackupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns information about the node Backups.
Declaration
public Task<ListNodeBackupsResponse> ListNodeBackups(ListNodeBackupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListNodeBackupsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListNodeBackupsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListNodeBackups API.
ListNodeReplaceConfigurations(ListNodeReplaceConfigurationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns information about the NodeReplaceConfiguration.
Declaration
public Task<ListNodeReplaceConfigurationsResponse> ListNodeReplaceConfigurations(ListNodeReplaceConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListNodeReplaceConfigurationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListNodeReplaceConfigurationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListNodeReplaceConfigurations API.
ListOsPatches(ListOsPatchesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List all available os patches for a given cluster
Declaration
public Task<ListOsPatchesResponse> ListOsPatches(ListOsPatchesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOsPatchesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOsPatchesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOsPatches API.
ListPatchHistories(ListPatchHistoriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List the patch history of this cluster.
Declaration
public Task<ListPatchHistoriesResponse> ListPatchHistories(ListPatchHistoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPatchHistoriesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPatchHistoriesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPatchHistories API.
ListPatches(ListPatchesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List all the available patches for this cluster.
Declaration
public Task<ListPatchesResponse> ListPatches(ListPatchesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPatchesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPatchesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPatches API.
ListResourcePrincipalConfigurations(ListResourcePrincipalConfigurationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns information about the ResourcePrincipalConfiguration.
Declaration
public Task<ListResourcePrincipalConfigurationsResponse> ListResourcePrincipalConfigurations(ListResourcePrincipalConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResourcePrincipalConfigurationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListResourcePrincipalConfigurationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResourcePrincipalConfigurations API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a paginated list of errors for a work request identified by the given ID.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a paginated list of logs for a given work request.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in a compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
RemoveAutoScalingConfiguration(RemoveAutoScalingConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes an autoscale configuration.
Declaration
public Task<RemoveAutoScalingConfigurationResponse> RemoveAutoScalingConfiguration(RemoveAutoScalingConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveAutoScalingConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveAutoScalingConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveAutoScalingConfiguration API.
RemoveCloudSql(RemoveCloudSqlRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes Cloud SQL from the cluster.
Declaration
public Task<RemoveCloudSqlResponse> RemoveCloudSql(RemoveCloudSqlRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveCloudSqlRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveCloudSqlResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveCloudSql API.
RemoveKafka(RemoveKafkaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Remove Kafka from the cluster.
Declaration
public Task<RemoveKafkaResponse> RemoveKafka(RemoveKafkaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveKafkaRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveKafkaResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveKafka API.
RemoveNode(RemoveNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Remove a single node of a Big Data Service cluster
Declaration
public Task<RemoveNodeResponse> RemoveNode(RemoveNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveNodeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveNodeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveNode API.
RemoveNodeReplaceConfiguration(RemoveNodeReplaceConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a nodeReplaceConfiguration
Declaration
public Task<RemoveNodeReplaceConfigurationResponse> RemoveNodeReplaceConfiguration(RemoveNodeReplaceConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveNodeReplaceConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveNodeReplaceConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveNodeReplaceConfiguration API.
RemoveResourcePrincipalConfiguration(RemoveResourcePrincipalConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the resource principal configuration for the cluster.
Declaration
public Task<RemoveResourcePrincipalConfigurationResponse> RemoveResourcePrincipalConfiguration(RemoveResourcePrincipalConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveResourcePrincipalConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveResourcePrincipalConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveResourcePrincipalConfiguration API.
RenewCertificate(RenewCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Renewing TLS/SSL for various ODH services running on the BDS cluster.
Declaration
public Task<RenewCertificateResponse> RenewCertificate(RenewCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RenewCertificateRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RenewCertificateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RenewCertificate API.
ReplaceNode(ReplaceNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Replaces a node of a Big Data Service cluster from backup.
Declaration
public Task<ReplaceNodeResponse> ReplaceNode(ReplaceNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ReplaceNodeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ReplaceNodeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ReplaceNode API.
RestartNode(RestartNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Restarts a single node of a Big Data Service cluster
Declaration
public Task<RestartNodeResponse> RestartNode(RestartNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RestartNodeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RestartNodeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RestartNode API.
StartBdsInstance(StartBdsInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts the BDS cluster that was stopped earlier.
Declaration
public Task<StartBdsInstanceResponse> StartBdsInstance(StartBdsInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
StartBdsInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<StartBdsInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StartBdsInstance API.
StopBdsInstance(StopBdsInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Stops the BDS cluster that can be started at later point of time.
Declaration
public Task<StopBdsInstanceResponse> StopBdsInstance(StopBdsInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
StopBdsInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<StopBdsInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StopBdsInstance API.
TestBdsMetastoreConfiguration(TestBdsMetastoreConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Test specified metastore configuration.
Declaration
public Task<TestBdsMetastoreConfigurationResponse> TestBdsMetastoreConfiguration(TestBdsMetastoreConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
TestBdsMetastoreConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<TestBdsMetastoreConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use TestBdsMetastoreConfiguration API.
TestBdsObjectStorageConnection(TestBdsObjectStorageConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Test access to specified Object Storage bucket using the API key.
Declaration
public Task<TestBdsObjectStorageConnectionResponse> TestBdsObjectStorageConnection(TestBdsObjectStorageConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
TestBdsObjectStorageConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<TestBdsObjectStorageConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use TestBdsObjectStorageConnection API.
UpdateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates fields on an autoscale configuration, including the name, the threshold value, and whether the autoscale configuration is enabled.
Declaration
public Task<UpdateAutoScalingConfigurationResponse> UpdateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAutoScalingConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateAutoScalingConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAutoScalingConfiguration API.
UpdateBdsInstance(UpdateBdsInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the Big Data Service cluster identified by the given ID.
Declaration
public Task<UpdateBdsInstanceResponse> UpdateBdsInstance(UpdateBdsInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateBdsInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateBdsInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateBdsInstance API.
UpdateBdsMetastoreConfiguration(UpdateBdsMetastoreConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update the BDS metastore configuration represented by the provided ID.
Declaration
public Task<UpdateBdsMetastoreConfigurationResponse> UpdateBdsMetastoreConfiguration(UpdateBdsMetastoreConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateBdsMetastoreConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateBdsMetastoreConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateBdsMetastoreConfiguration API.
UpdateNodeBackupConfiguration(UpdateNodeBackupConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates fields on NodeBackupConfiguration, including the name, the schedule.
Declaration
public Task<UpdateNodeBackupConfigurationResponse> UpdateNodeBackupConfiguration(UpdateNodeBackupConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateNodeBackupConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateNodeBackupConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateNodeBackupConfiguration API.
UpdateNodeReplaceConfiguration(UpdateNodeReplaceConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates fields on nodeReplaceConfigurations, including the name, the schedule
Declaration
public Task<UpdateNodeReplaceConfigurationResponse> UpdateNodeReplaceConfiguration(UpdateNodeReplaceConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateNodeReplaceConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateNodeReplaceConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateNodeReplaceConfiguration API.
UpdateResourcePrincipalConfiguration(UpdateResourcePrincipalConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates fields on resourcePrincipalConfiguration, including the name, the lifeSpanInHours of the token.
Declaration
public Task<UpdateResourcePrincipalConfigurationResponse> UpdateResourcePrincipalConfiguration(UpdateResourcePrincipalConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateResourcePrincipalConfigurationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateResourcePrincipalConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateResourcePrincipalConfiguration API.