com.oracle.bmc.databasemanagement

Interface SqlTuningAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SqlTuningAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201101")
public interface SqlTuningAsync
extends AutoCloseable

Use the Database Management API to perform tasks such as obtaining performance and resource usage metrics for a fleet of Managed Databases or a specific Managed Database, creating Managed Database Groups, and running a SQL job on a Managed Database or Managed Database Group.

Method Summary

Modifier and Type	Method and Description
Future<CloneSqlTuningTaskResponse>	cloneSqlTuningTask(CloneSqlTuningTaskRequest request, AsyncHandler<CloneSqlTuningTaskRequest,CloneSqlTuningTaskResponse> handler) Clones and runs a SQL tuning task in the database.
Future<DropSqlTuningTaskResponse>	dropSqlTuningTask(DropSqlTuningTaskRequest request, AsyncHandler<DropSqlTuningTaskRequest,DropSqlTuningTaskResponse> handler) Drops a SQL tuning task and its related results from the database.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetExecutionPlanStatsComparisionResponse>	getExecutionPlanStatsComparision(GetExecutionPlanStatsComparisionRequest request, AsyncHandler<GetExecutionPlanStatsComparisionRequest,GetExecutionPlanStatsComparisionResponse> handler) Retrieves a comparison of the existing SQL execution plan and a new plan.
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.
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<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.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

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.

cloneSqlTuningTask

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

Clones and runs a SQL tuning task in the database.

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

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

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

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

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

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.

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

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

Retrieves a SQL execution plan for the SQL being tuned.

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

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

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

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

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

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

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

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

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.

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

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

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

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

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.

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.