Class OpensearchClusterClient
Service client instance for OpensearchCluster.
Implements
Inherited Members
Namespace: Oci.OpensearchService
Assembly: OCI.DotNetSDK.Opensearch.dll
Syntax
public class OpensearchClusterClient : RegionalClientBase, IDisposable
Constructors
OpensearchClusterClient(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 OpensearchClusterClient(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 OpensearchClusterPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
OpensearchClusterPaginators |
Waiters
Declaration
public OpensearchClusterWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
OpensearchClusterWaiters |
Methods
BackupOpensearchCluster(BackupOpensearchClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Backup the opensearch cluster details.
Declaration
public Task<BackupOpensearchClusterResponse> BackupOpensearchCluster(BackupOpensearchClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BackupOpensearchClusterRequest | 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<BackupOpensearchClusterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BackupOpensearchCluster API.
CreateOpensearchCluster(CreateOpensearchClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new OpensearchCluster.
Declaration
public Task<CreateOpensearchClusterResponse> CreateOpensearchCluster(CreateOpensearchClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOpensearchClusterRequest | 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<CreateOpensearchClusterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOpensearchCluster API.
DeleteOpensearchCluster(DeleteOpensearchClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a OpensearchCluster resource by identifier
Declaration
public Task<DeleteOpensearchClusterResponse> DeleteOpensearchCluster(DeleteOpensearchClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteOpensearchClusterRequest | 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<DeleteOpensearchClusterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteOpensearchCluster API.
GetOpensearchCluster(GetOpensearchClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a OpensearchCluster by identifier
Declaration
public Task<GetOpensearchClusterResponse> GetOpensearchCluster(GetOpensearchClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetOpensearchClusterRequest | 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<GetOpensearchClusterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetOpensearchCluster API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the status of the work request with 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.
ListOpensearchClusters(ListOpensearchClustersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of OpensearchClusters.
Declaration
public Task<ListOpensearchClustersResponse> ListOpensearchClusters(ListOpensearchClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOpensearchClustersRequest | 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<ListOpensearchClustersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOpensearchClusters API.
ListOpensearchVersions(ListOpensearchVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the supported Opensearch versions
Declaration
public Task<ListOpensearchVersionsResponse> ListOpensearchVersions(ListOpensearchVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOpensearchVersionsRequest | 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<ListOpensearchVersionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOpensearchVersions API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a (paginated) list of errors for a given work request.
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)
Return 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.
OpensearchClusterRestore(OpensearchClusterRestoreRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Restore the opensearch cluster details.
Declaration
public Task<OpensearchClusterRestoreResponse> OpensearchClusterRestore(OpensearchClusterRestoreRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
OpensearchClusterRestoreRequest | 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<OpensearchClusterRestoreResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use OpensearchClusterRestore API.
ResizeOpensearchClusterHorizontal(ResizeOpensearchClusterHorizontalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Resize the opensearch cluster horizontal details.
Declaration
public Task<ResizeOpensearchClusterHorizontalResponse> ResizeOpensearchClusterHorizontal(ResizeOpensearchClusterHorizontalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ResizeOpensearchClusterHorizontalRequest | 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<ResizeOpensearchClusterHorizontalResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ResizeOpensearchClusterHorizontal API.
ResizeOpensearchClusterVertical(ResizeOpensearchClusterVerticalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Resize the opensearch cluster vertical details.
Declaration
public Task<ResizeOpensearchClusterVerticalResponse> ResizeOpensearchClusterVertical(ResizeOpensearchClusterVerticalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ResizeOpensearchClusterVerticalRequest | 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<ResizeOpensearchClusterVerticalResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ResizeOpensearchClusterVertical API.
UpdateOpensearchCluster(UpdateOpensearchClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the OpensearchCluster
Declaration
public Task<UpdateOpensearchClusterResponse> UpdateOpensearchCluster(UpdateOpensearchClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateOpensearchClusterRequest | 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<UpdateOpensearchClusterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateOpensearchCluster API.