Package com.oracle.bmc.opensearch

Class OpensearchClusterAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.opensearch.OpensearchClusterAsyncClient

All Implemented Interfaces:

OpensearchClusterAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180828")
public class OpensearchClusterAsyncClient
extends BaseAsyncClient
implements OpensearchClusterAsync

Async client implementation for OpensearchCluster service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpensearchClusterAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for OpensearchCluster.

Constructor Summary

Constructors

Constructor	Description
OpensearchClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
OpensearchClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
OpensearchClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
OpensearchClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
OpensearchClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
OpensearchClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
OpensearchClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
Future<BackupOpensearchClusterResponse>	backupOpensearchCluster(BackupOpensearchClusterRequest request, AsyncHandler<BackupOpensearchClusterRequest,BackupOpensearchClusterResponse> handler)	Backup the opensearch cluster details.
static OpensearchClusterAsyncClient.Builder	builder()	Create a builder for this client.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<ConfigureOutboundClusterResponse>	configureOutboundCluster(ConfigureOutboundClusterRequest request, AsyncHandler<ConfigureOutboundClusterRequest,ConfigureOutboundClusterResponse> handler)	Configure Outbound cluster for cross-cluster operations
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	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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<ListOpensearchClusterShapesResponse>	listOpensearchClusterShapes(ListOpensearchClusterShapesRequest request, AsyncHandler<ListOpensearchClusterShapesRequest,ListOpensearchClusterShapesResponse> handler)	Retrieves available OpenSearch Cluster node shapes.
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
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)
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdateOpensearchClusterResponse>	updateOpensearchCluster(UpdateOpensearchClusterRequest request, AsyncHandler<UpdateOpensearchClusterRequest,UpdateOpensearchClusterResponse> handler)	Updates the OpensearchCluster
Future<UpgradeOpenSearchClusterResponse>	upgradeOpenSearchCluster(UpgradeOpenSearchClusterRequest request, AsyncHandler<UpgradeOpenSearchClusterRequest,UpgradeOpenSearchClusterResponse> handler)	Upgrade or clone the opensearch cluster.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.opensearch.OpensearchClusterAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for OpensearchCluster.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

OpensearchClusterAsyncClient

@Deprecated
public OpensearchClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OpensearchClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

OpensearchClusterAsyncClient

@Deprecated
public OpensearchClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OpensearchClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

OpensearchClusterAsyncClient

@Deprecated
public OpensearchClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OpensearchClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

OpensearchClusterAsyncClient

@Deprecated
public OpensearchClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OpensearchClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OpensearchClusterAsyncClient

@Deprecated
public OpensearchClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OpensearchClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OpensearchClusterAsyncClient

@Deprecated
public OpensearchClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OpensearchClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

OpensearchClusterAsyncClient

@Deprecated
public OpensearchClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OpensearchClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static OpensearchClusterAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OpensearchClusterAsync

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.

Specified by:

setRegion in interface OpensearchClusterAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OpensearchClusterAsync

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.

Specified by:

setRegion in interface OpensearchClusterAsync

Parameters:

regionId - The public region ID.

backupOpensearchCluster

public Future<BackupOpensearchClusterResponse> backupOpensearchCluster(BackupOpensearchClusterRequest request,
                                                                       AsyncHandler<BackupOpensearchClusterRequest,BackupOpensearchClusterResponse> handler)

Description copied from interface: OpensearchClusterAsync

Backup the opensearch cluster details.

Specified by:

backupOpensearchCluster in interface OpensearchClusterAsync

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.

configureOutboundCluster

public Future<ConfigureOutboundClusterResponse> configureOutboundCluster(ConfigureOutboundClusterRequest request,
                                                                         AsyncHandler<ConfigureOutboundClusterRequest,ConfigureOutboundClusterResponse> handler)

Description copied from interface: OpensearchClusterAsync

Configure Outbound cluster for cross-cluster operations

Specified by:

configureOutboundCluster in interface OpensearchClusterAsync

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

public Future<CreateOpensearchClusterResponse> createOpensearchCluster(CreateOpensearchClusterRequest request,
                                                                       AsyncHandler<CreateOpensearchClusterRequest,CreateOpensearchClusterResponse> handler)

Description copied from interface: OpensearchClusterAsync

Creates a new OpensearchCluster.

Specified by:

createOpensearchCluster in interface OpensearchClusterAsync

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

public Future<DeleteOpensearchClusterResponse> deleteOpensearchCluster(DeleteOpensearchClusterRequest request,
                                                                       AsyncHandler<DeleteOpensearchClusterRequest,DeleteOpensearchClusterResponse> handler)

Description copied from interface: OpensearchClusterAsync

Deletes a OpensearchCluster resource by identifier

Specified by:

deleteOpensearchCluster in interface OpensearchClusterAsync

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

public Future<GetOpensearchClusterResponse> getOpensearchCluster(GetOpensearchClusterRequest request,
                                                                 AsyncHandler<GetOpensearchClusterRequest,GetOpensearchClusterResponse> handler)

Description copied from interface: OpensearchClusterAsync

Gets a OpensearchCluster by identifier

Specified by:

getOpensearchCluster in interface OpensearchClusterAsync

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

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: OpensearchClusterAsync

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface OpensearchClusterAsync

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.

listOpensearchClusterShapes

public Future<ListOpensearchClusterShapesResponse> listOpensearchClusterShapes(ListOpensearchClusterShapesRequest request,
                                                                               AsyncHandler<ListOpensearchClusterShapesRequest,ListOpensearchClusterShapesResponse> handler)

Description copied from interface: OpensearchClusterAsync

Retrieves available OpenSearch Cluster node shapes.

Specified by:

listOpensearchClusterShapes in interface OpensearchClusterAsync

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

public Future<ListOpensearchClustersResponse> listOpensearchClusters(ListOpensearchClustersRequest request,
                                                                     AsyncHandler<ListOpensearchClustersRequest,ListOpensearchClustersResponse> handler)

Description copied from interface: OpensearchClusterAsync

Returns a list of OpensearchClusters.

Specified by:

listOpensearchClusters in interface OpensearchClusterAsync

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

public Future<ListOpensearchVersionsResponse> listOpensearchVersions(ListOpensearchVersionsRequest request,
                                                                     AsyncHandler<ListOpensearchVersionsRequest,ListOpensearchVersionsResponse> handler)

Description copied from interface: OpensearchClusterAsync

Lists the supported Opensearch versions

Specified by:

listOpensearchVersions in interface OpensearchClusterAsync

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

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: OpensearchClusterAsync

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface OpensearchClusterAsync

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

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: OpensearchClusterAsync

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface OpensearchClusterAsync

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

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: OpensearchClusterAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface OpensearchClusterAsync

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

public Future<OpensearchClusterRestoreResponse> opensearchClusterRestore(OpensearchClusterRestoreRequest request,
                                                                         AsyncHandler<OpensearchClusterRestoreRequest,OpensearchClusterRestoreResponse> handler)

Description copied from interface: OpensearchClusterAsync

Restore the opensearch cluster details.

Specified by:

opensearchClusterRestore in interface OpensearchClusterAsync

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

public Future<ResizeOpensearchClusterHorizontalResponse> resizeOpensearchClusterHorizontal(ResizeOpensearchClusterHorizontalRequest request,
                                                                                           AsyncHandler<ResizeOpensearchClusterHorizontalRequest,ResizeOpensearchClusterHorizontalResponse> handler)

Description copied from interface: OpensearchClusterAsync

Resize the opensearch cluster horizontal details.

Specified by:

resizeOpensearchClusterHorizontal in interface OpensearchClusterAsync

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

public Future<ResizeOpensearchClusterVerticalResponse> resizeOpensearchClusterVertical(ResizeOpensearchClusterVerticalRequest request,
                                                                                       AsyncHandler<ResizeOpensearchClusterVerticalRequest,ResizeOpensearchClusterVerticalResponse> handler)

Description copied from interface: OpensearchClusterAsync

Resize the opensearch cluster vertical details.

Specified by:

resizeOpensearchClusterVertical in interface OpensearchClusterAsync

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

public Future<UpdateOpensearchClusterResponse> updateOpensearchCluster(UpdateOpensearchClusterRequest request,
                                                                       AsyncHandler<UpdateOpensearchClusterRequest,UpdateOpensearchClusterResponse> handler)

Description copied from interface: OpensearchClusterAsync

Updates the OpensearchCluster

Specified by:

updateOpensearchCluster in interface OpensearchClusterAsync

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.

upgradeOpenSearchCluster

public Future<UpgradeOpenSearchClusterResponse> upgradeOpenSearchCluster(UpgradeOpenSearchClusterRequest request,
                                                                         AsyncHandler<UpgradeOpenSearchClusterRequest,UpgradeOpenSearchClusterResponse> handler)

Description copied from interface: OpensearchClusterAsync

Upgrade or clone the opensearch cluster.

Specified by:

upgradeOpenSearchCluster in interface OpensearchClusterAsync

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)