OpensearchClusterAsync (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

OpensearchClusterAsyncClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180828")
public interface OpensearchClusterAsync
extends AutoCloseable
```
The OpenSearch service API provides access to OCI Search Service with OpenSearch.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<BackupOpensearchClusterResponse>`	`backupOpensearchCluster(BackupOpensearchClusterRequest request, AsyncHandler<BackupOpensearchClusterRequest,BackupOpensearchClusterResponse> handler)` Backup the opensearch cluster details.
`Future<CreateOpensearchClusterResponse>`	`createOpensearchCluster(CreateOpensearchClusterRequest request, AsyncHandler<CreateOpensearchClusterRequest,CreateOpensearchClusterResponse> handler)` Creates a new OpensearchCluster.
`Future<DeleteOpensearchClusterResponse>`	`deleteOpensearchCluster(DeleteOpensearchClusterRequest request, AsyncHandler<DeleteOpensearchClusterRequest,DeleteOpensearchClusterResponse> handler)` Deletes a OpensearchCluster resource by identifier
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`Future<GetOpensearchClusterResponse>`	`getOpensearchCluster(GetOpensearchClusterRequest request, AsyncHandler<GetOpensearchClusterRequest,GetOpensearchClusterResponse> handler)` Gets a OpensearchCluster by identifier
`Future<GetWorkRequestResponse>`	`getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)` Gets the status of the work request with the given ID.
`Future<ListOpensearchClustersResponse>`	`listOpensearchClusters(ListOpensearchClustersRequest request, AsyncHandler<ListOpensearchClustersRequest,ListOpensearchClustersResponse> handler)` Returns a list of OpensearchClusters.
`Future<ListOpensearchVersionsResponse>`	`listOpensearchVersions(ListOpensearchVersionsRequest request, AsyncHandler<ListOpensearchVersionsRequest,ListOpensearchVersionsResponse> handler)` Lists the supported Opensearch versions
`Future<ListWorkRequestErrorsResponse>`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)` Return a (paginated) list of errors for a given work request.
`Future<ListWorkRequestLogsResponse>`	`listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)` Return a (paginated) list of logs for a given work request.
`Future<ListWorkRequestsResponse>`	`listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)` Lists the work requests in a compartment.
`Future<OpensearchClusterRestoreResponse>`	`opensearchClusterRestore(OpensearchClusterRestoreRequest request, AsyncHandler<OpensearchClusterRestoreRequest,OpensearchClusterRestoreResponse> handler)` Restore the opensearch cluster details.
`void`	`refreshClient()` Rebuilds the client from scratch.
`Future<ResizeOpensearchClusterHorizontalResponse>`	`resizeOpensearchClusterHorizontal(ResizeOpensearchClusterHorizontalRequest request, AsyncHandler<ResizeOpensearchClusterHorizontalRequest,ResizeOpensearchClusterHorizontalResponse> handler)` Resize the opensearch cluster horizontal details.
`Future<ResizeOpensearchClusterVerticalResponse>`	`resizeOpensearchClusterVertical(ResizeOpensearchClusterVerticalRequest request, AsyncHandler<ResizeOpensearchClusterVerticalRequest,ResizeOpensearchClusterVerticalResponse> handler)` Resize the opensearch cluster vertical details.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`Future<UpdateOpensearchClusterResponse>`	`updateOpensearchCluster(UpdateOpensearchClusterRequest request, AsyncHandler<UpdateOpensearchClusterRequest,UpdateOpensearchClusterResponse> handler)` Updates the OpensearchCluster
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the serice.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    Sets the region to call (ex, Region.US_PHOENIX_1).
    
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    Sets the region to call (ex, ‘us-phoenix-1’).
    
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - backupOpensearchCluster
```
Future<BackupOpensearchClusterResponse> backupOpensearchCluster(BackupOpensearchClusterRequest request,
                                                                AsyncHandler<BackupOpensearchClusterRequest,BackupOpensearchClusterResponse> handler)
```
    Backup the opensearch cluster details.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createOpensearchCluster
```
Future<CreateOpensearchClusterResponse> createOpensearchCluster(CreateOpensearchClusterRequest request,
                                                                AsyncHandler<CreateOpensearchClusterRequest,CreateOpensearchClusterResponse> handler)
```
    Creates a new OpensearchCluster.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteOpensearchCluster
```
Future<DeleteOpensearchClusterResponse> deleteOpensearchCluster(DeleteOpensearchClusterRequest request,
                                                                AsyncHandler<DeleteOpensearchClusterRequest,DeleteOpensearchClusterResponse> handler)
```
    Deletes a OpensearchCluster resource by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getOpensearchCluster
```
Future<GetOpensearchClusterResponse> getOpensearchCluster(GetOpensearchClusterRequest request,
                                                          AsyncHandler<GetOpensearchClusterRequest,GetOpensearchClusterResponse> handler)
```
    Gets a OpensearchCluster by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getWorkRequest
```
Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
```
    Gets the status of the work request with the given ID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listOpensearchClusters
```
Future<ListOpensearchClustersResponse> listOpensearchClusters(ListOpensearchClustersRequest request,
                                                              AsyncHandler<ListOpensearchClustersRequest,ListOpensearchClustersResponse> handler)
```
    Returns a list of OpensearchClusters.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listOpensearchVersions
```
Future<ListOpensearchVersionsResponse> listOpensearchVersions(ListOpensearchVersionsRequest request,
                                                              AsyncHandler<ListOpensearchVersionsRequest,ListOpensearchVersionsResponse> handler)
```
    Lists the supported Opensearch versions
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequestErrors
```
Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
```
    Return a (paginated) list of errors for a given work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequestLogs
```
Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
```
    Return a (paginated) list of logs for a given work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequests
```
Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
```
    Lists the work requests in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - opensearchClusterRestore
```
Future<OpensearchClusterRestoreResponse> opensearchClusterRestore(OpensearchClusterRestoreRequest request,
                                                                  AsyncHandler<OpensearchClusterRestoreRequest,OpensearchClusterRestoreResponse> handler)
```
    Restore the opensearch cluster details.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - resizeOpensearchClusterHorizontal
```
Future<ResizeOpensearchClusterHorizontalResponse> resizeOpensearchClusterHorizontal(ResizeOpensearchClusterHorizontalRequest request,
                                                                                    AsyncHandler<ResizeOpensearchClusterHorizontalRequest,ResizeOpensearchClusterHorizontalResponse> handler)
```
    Resize the opensearch cluster horizontal details.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - resizeOpensearchClusterVertical
```
Future<ResizeOpensearchClusterVerticalResponse> resizeOpensearchClusterVertical(ResizeOpensearchClusterVerticalRequest request,
                                                                                AsyncHandler<ResizeOpensearchClusterVerticalRequest,ResizeOpensearchClusterVerticalResponse> handler)
```
    Resize the opensearch cluster vertical details.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateOpensearchCluster
```
Future<UpdateOpensearchClusterResponse> updateOpensearchCluster(UpdateOpensearchClusterRequest request,
                                                                AsyncHandler<UpdateOpensearchClusterRequest,UpdateOpensearchClusterResponse> handler)
```
    Updates the OpensearchCluster
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

Interface OpensearchClusterAsync

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

backupOpensearchCluster

createOpensearchCluster

deleteOpensearchCluster

getOpensearchCluster

getWorkRequest

listOpensearchClusters

listOpensearchVersions

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

opensearchClusterRestore

resizeOpensearchClusterHorizontal

resizeOpensearchClusterVertical

updateOpensearchCluster