Package com.oracle.bmc.databasemanagement

Class SqlTuningAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.databasemanagement.SqlTuningAsyncClient

All Implemented Interfaces:

SqlTuningAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201101")
public class SqlTuningAsyncClient
extends BaseAsyncClient
implements SqlTuningAsync

Async client implementation for SqlTuning 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	SqlTuningAsyncClient.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 SqlTuning.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SqlTuningAsyncClient.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)
Future<CloneSqlTuningTaskResponse>	cloneSqlTuningTask(CloneSqlTuningTaskRequest request, AsyncHandler<CloneSqlTuningTaskRequest,CloneSqlTuningTaskResponse> handler)	Clones and runs a SQL tuning task in the database.
void	close()
Future<CreateSqlTuningSetResponse>	createSqlTuningSet(CreateSqlTuningSetRequest request, AsyncHandler<CreateSqlTuningSetRequest,CreateSqlTuningSetResponse> handler)	Creates an empty Sql tuning set within the Managed Database specified by managedDatabaseId.
Future<DropSqlsInSqlTuningSetResponse>	dropSqlsInSqlTuningSet(DropSqlsInSqlTuningSetRequest request, AsyncHandler<DropSqlsInSqlTuningSetRequest,DropSqlsInSqlTuningSetResponse> handler)	Deletes the Sqls in the specified Sql tuning set that matches the filter criteria provided in the basicFilter.
Future<DropSqlTuningSetResponse>	dropSqlTuningSet(DropSqlTuningSetRequest request, AsyncHandler<DropSqlTuningSetRequest,DropSqlTuningSetResponse> handler)	Drops the Sql tuning set specified by sqlTuningSet within the Managed Database specified by managedDatabaseId.
Future<DropSqlTuningTaskResponse>	dropSqlTuningTask(DropSqlTuningTaskRequest request, AsyncHandler<DropSqlTuningTaskRequest,DropSqlTuningTaskResponse> handler)	Drops a SQL tuning task and its related results from the database.
Future<FetchSqlTuningSetResponse>	fetchSqlTuningSet(FetchSqlTuningSetRequest request, AsyncHandler<FetchSqlTuningSetRequest,FetchSqlTuningSetResponse> handler)	Fetch the details of Sql statements in the Sql tuning set specified by name, owner and optional filter parameters.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetExecutionPlanStatsComparisionResponse>	getExecutionPlanStatsComparision(GetExecutionPlanStatsComparisionRequest request, AsyncHandler<GetExecutionPlanStatsComparisionRequest,GetExecutionPlanStatsComparisionResponse> handler)	Retrieves a comparison of the existing SQL execution plan and a new plan.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetSqlExecutionPlanResponse>	getSqlExecutionPlan(GetSqlExecutionPlanRequest request, AsyncHandler<GetSqlExecutionPlanRequest,GetSqlExecutionPlanResponse> handler)	Retrieves a SQL execution plan for the SQL being tuned.
Future<GetSqlTuningAdvisorTaskSummaryReportResponse>	getSqlTuningAdvisorTaskSummaryReport(GetSqlTuningAdvisorTaskSummaryReportRequest request, AsyncHandler<GetSqlTuningAdvisorTaskSummaryReportRequest,GetSqlTuningAdvisorTaskSummaryReportResponse> handler)	Gets the summary report for the specified SQL Tuning Advisor task.
Future<ListSqlTuningAdvisorTaskFindingsResponse>	listSqlTuningAdvisorTaskFindings(ListSqlTuningAdvisorTaskFindingsRequest request, AsyncHandler<ListSqlTuningAdvisorTaskFindingsRequest,ListSqlTuningAdvisorTaskFindingsResponse> handler)	Gets an array of the details of the findings that match specific filters.
Future<ListSqlTuningAdvisorTaskRecommendationsResponse>	listSqlTuningAdvisorTaskRecommendations(ListSqlTuningAdvisorTaskRecommendationsRequest request, AsyncHandler<ListSqlTuningAdvisorTaskRecommendationsRequest,ListSqlTuningAdvisorTaskRecommendationsResponse> handler)	Gets the findings and possible actions for a given object in a SQL tuning task.
Future<ListSqlTuningAdvisorTasksResponse>	listSqlTuningAdvisorTasks(ListSqlTuningAdvisorTasksRequest request, AsyncHandler<ListSqlTuningAdvisorTasksRequest,ListSqlTuningAdvisorTasksResponse> handler)	Lists the SQL Tuning Advisor tasks for the specified Managed Database.
Future<ListSqlTuningSetsResponse>	listSqlTuningSets(ListSqlTuningSetsRequest request, AsyncHandler<ListSqlTuningSetsRequest,ListSqlTuningSetsResponse> handler)	Lists the SQL tuning sets for the specified Managed Database.
Future<LoadSqlTuningSetResponse>	loadSqlTuningSet(LoadSqlTuningSetRequest request, AsyncHandler<LoadSqlTuningSetRequest,LoadSqlTuningSetResponse> handler)	Load Sql statements into the Sql tuning set specified by name and optional filter parameters within the Managed Database specified by managedDatabaseId.
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<SaveSqlTuningSetAsResponse>	saveSqlTuningSetAs(SaveSqlTuningSetAsRequest request, AsyncHandler<SaveSqlTuningSetAsRequest,SaveSqlTuningSetAsResponse> handler)	Saves the specified list of Sqls statements into another new Sql tuning set or loads into an existing Sql tuning set’.
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’).
Future<StartSqlTuningTaskResponse>	startSqlTuningTask(StartSqlTuningTaskRequest request, AsyncHandler<StartSqlTuningTaskRequest,StartSqlTuningTaskResponse> handler)	Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.
Future<ValidateBasicFilterResponse>	validateBasicFilter(ValidateBasicFilterRequest request, AsyncHandler<ValidateBasicFilterRequest,ValidateBasicFilterResponse> handler)	Executes a SQL query to check whether user entered basic filter criteria is valid or not.

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.databasemanagement.SqlTuningAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for SqlTuning.

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

SqlTuningAsyncClient

@Deprecated
public SqlTuningAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

SqlTuningAsyncClient

@Deprecated
public SqlTuningAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

SqlTuningAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

SqlTuningAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

SqlTuningAsyncClient

@Deprecated
public SqlTuningAsyncClient(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 SqlTuningAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

SqlTuningAsyncClient

@Deprecated
public SqlTuningAsyncClient(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 SqlTuningAsyncClient.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)

SqlTuningAsyncClient

@Deprecated
public SqlTuningAsyncClient(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 SqlTuningAsyncClient.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 SqlTuningAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: SqlTuningAsync

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 SqlTuningAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: SqlTuningAsync

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 SqlTuningAsync

Parameters:

regionId - The public region ID.

cloneSqlTuningTask

public Future<CloneSqlTuningTaskResponse> cloneSqlTuningTask(CloneSqlTuningTaskRequest request,
                                                             AsyncHandler<CloneSqlTuningTaskRequest,CloneSqlTuningTaskResponse> handler)

Description copied from interface: SqlTuningAsync

Clones and runs a SQL tuning task in the database.

Specified by:

cloneSqlTuningTask in interface SqlTuningAsync

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.

createSqlTuningSet

public Future<CreateSqlTuningSetResponse> createSqlTuningSet(CreateSqlTuningSetRequest request,
                                                             AsyncHandler<CreateSqlTuningSetRequest,CreateSqlTuningSetResponse> handler)

Description copied from interface: SqlTuningAsync

Creates an empty Sql tuning set within the Managed Database specified by managedDatabaseId.

Specified by:

createSqlTuningSet in interface SqlTuningAsync

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.

dropSqlTuningSet

public Future<DropSqlTuningSetResponse> dropSqlTuningSet(DropSqlTuningSetRequest request,
                                                         AsyncHandler<DropSqlTuningSetRequest,DropSqlTuningSetResponse> handler)

Description copied from interface: SqlTuningAsync

Drops the Sql tuning set specified by sqlTuningSet within the Managed Database specified by managedDatabaseId.

Specified by:

dropSqlTuningSet in interface SqlTuningAsync

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.

dropSqlTuningTask

public Future<DropSqlTuningTaskResponse> dropSqlTuningTask(DropSqlTuningTaskRequest request,
                                                           AsyncHandler<DropSqlTuningTaskRequest,DropSqlTuningTaskResponse> handler)

Description copied from interface: SqlTuningAsync

Drops a SQL tuning task and its related results from the database.

Specified by:

dropSqlTuningTask in interface SqlTuningAsync

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.

dropSqlsInSqlTuningSet

public Future<DropSqlsInSqlTuningSetResponse> dropSqlsInSqlTuningSet(DropSqlsInSqlTuningSetRequest request,
                                                                     AsyncHandler<DropSqlsInSqlTuningSetRequest,DropSqlsInSqlTuningSetResponse> handler)

Description copied from interface: SqlTuningAsync

Deletes the Sqls in the specified Sql tuning set that matches the filter criteria provided in the basicFilter.

If basicFilter criteria is not provided, then entire Sqls in the Sql tuning set is deleted.

Specified by:

dropSqlsInSqlTuningSet in interface SqlTuningAsync

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.

fetchSqlTuningSet

public Future<FetchSqlTuningSetResponse> fetchSqlTuningSet(FetchSqlTuningSetRequest request,
                                                           AsyncHandler<FetchSqlTuningSetRequest,FetchSqlTuningSetResponse> handler)

Description copied from interface: SqlTuningAsync

Fetch the details of Sql statements in the Sql tuning set specified by name, owner and optional filter parameters.

Specified by:

fetchSqlTuningSet in interface SqlTuningAsync

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.

getExecutionPlanStatsComparision

public Future<GetExecutionPlanStatsComparisionResponse> getExecutionPlanStatsComparision(GetExecutionPlanStatsComparisionRequest request,
                                                                                         AsyncHandler<GetExecutionPlanStatsComparisionRequest,GetExecutionPlanStatsComparisionResponse> handler)

Description copied from interface: SqlTuningAsync

Retrieves a comparison of the existing SQL execution plan and a new plan.

A SQL tuning task may suggest a new execution plan for a SQL, and this API retrieves the comparison report of the statistics of the two plans.

Specified by:

getExecutionPlanStatsComparision in interface SqlTuningAsync

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.

getSqlExecutionPlan

public Future<GetSqlExecutionPlanResponse> getSqlExecutionPlan(GetSqlExecutionPlanRequest request,
                                                               AsyncHandler<GetSqlExecutionPlanRequest,GetSqlExecutionPlanResponse> handler)

Description copied from interface: SqlTuningAsync

Retrieves a SQL execution plan for the SQL being tuned.

Specified by:

getSqlExecutionPlan in interface SqlTuningAsync

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.

getSqlTuningAdvisorTaskSummaryReport

public Future<GetSqlTuningAdvisorTaskSummaryReportResponse> getSqlTuningAdvisorTaskSummaryReport(GetSqlTuningAdvisorTaskSummaryReportRequest request,
                                                                                                 AsyncHandler<GetSqlTuningAdvisorTaskSummaryReportRequest,GetSqlTuningAdvisorTaskSummaryReportResponse> handler)

Description copied from interface: SqlTuningAsync

Gets the summary report for the specified SQL Tuning Advisor task.

Specified by:

getSqlTuningAdvisorTaskSummaryReport in interface SqlTuningAsync

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.

listSqlTuningAdvisorTaskFindings

public Future<ListSqlTuningAdvisorTaskFindingsResponse> listSqlTuningAdvisorTaskFindings(ListSqlTuningAdvisorTaskFindingsRequest request,
                                                                                         AsyncHandler<ListSqlTuningAdvisorTaskFindingsRequest,ListSqlTuningAdvisorTaskFindingsResponse> handler)

Description copied from interface: SqlTuningAsync

Gets an array of the details of the findings that match specific filters.

Specified by:

listSqlTuningAdvisorTaskFindings in interface SqlTuningAsync

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.

listSqlTuningAdvisorTaskRecommendations

public Future<ListSqlTuningAdvisorTaskRecommendationsResponse> listSqlTuningAdvisorTaskRecommendations(ListSqlTuningAdvisorTaskRecommendationsRequest request,
                                                                                                       AsyncHandler<ListSqlTuningAdvisorTaskRecommendationsRequest,ListSqlTuningAdvisorTaskRecommendationsResponse> handler)

Description copied from interface: SqlTuningAsync

Gets the findings and possible actions for a given object in a SQL tuning task.

The task ID and object ID are used to retrieve the findings and recommendations.

Specified by:

listSqlTuningAdvisorTaskRecommendations in interface SqlTuningAsync

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.

listSqlTuningAdvisorTasks

public Future<ListSqlTuningAdvisorTasksResponse> listSqlTuningAdvisorTasks(ListSqlTuningAdvisorTasksRequest request,
                                                                           AsyncHandler<ListSqlTuningAdvisorTasksRequest,ListSqlTuningAdvisorTasksResponse> handler)

Description copied from interface: SqlTuningAsync

Lists the SQL Tuning Advisor tasks for the specified Managed Database.

Specified by:

listSqlTuningAdvisorTasks in interface SqlTuningAsync

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.

listSqlTuningSets

public Future<ListSqlTuningSetsResponse> listSqlTuningSets(ListSqlTuningSetsRequest request,
                                                           AsyncHandler<ListSqlTuningSetsRequest,ListSqlTuningSetsResponse> handler)

Description copied from interface: SqlTuningAsync

Lists the SQL tuning sets for the specified Managed Database.

Specified by:

listSqlTuningSets in interface SqlTuningAsync

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.

loadSqlTuningSet

public Future<LoadSqlTuningSetResponse> loadSqlTuningSet(LoadSqlTuningSetRequest request,
                                                         AsyncHandler<LoadSqlTuningSetRequest,LoadSqlTuningSetResponse> handler)

Description copied from interface: SqlTuningAsync

Load Sql statements into the Sql tuning set specified by name and optional filter parameters within the Managed Database specified by managedDatabaseId.

Specified by:

loadSqlTuningSet in interface SqlTuningAsync

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.

saveSqlTuningSetAs

public Future<SaveSqlTuningSetAsResponse> saveSqlTuningSetAs(SaveSqlTuningSetAsRequest request,
                                                             AsyncHandler<SaveSqlTuningSetAsRequest,SaveSqlTuningSetAsResponse> handler)

Description copied from interface: SqlTuningAsync

Saves the specified list of Sqls statements into another new Sql tuning set or loads into an existing Sql tuning set’.

Specified by:

saveSqlTuningSetAs in interface SqlTuningAsync

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.

startSqlTuningTask

public Future<StartSqlTuningTaskResponse> startSqlTuningTask(StartSqlTuningTaskRequest request,
                                                             AsyncHandler<StartSqlTuningTaskRequest,StartSqlTuningTaskResponse> handler)

Description copied from interface: SqlTuningAsync

Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements.

Specified by:

startSqlTuningTask in interface SqlTuningAsync

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.

validateBasicFilter

public Future<ValidateBasicFilterResponse> validateBasicFilter(ValidateBasicFilterRequest request,
                                                               AsyncHandler<ValidateBasicFilterRequest,ValidateBasicFilterResponse> handler)

Description copied from interface: SqlTuningAsync

Executes a SQL query to check whether user entered basic filter criteria is valid or not.

Specified by:

validateBasicFilter in interface SqlTuningAsync

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)