Package 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 monitor and manage resources such as Oracle Databases, MySQL Databases, and External Database Systems.

    For more information, see Database Management.

    • 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

      • 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.

      • createSqlTuningSet

        Future<CreateSqlTuningSetResponse> createSqlTuningSet​(CreateSqlTuningSetRequest request,
                                                      AsyncHandler<CreateSqlTuningSetRequest,​CreateSqlTuningSetResponse> handler)
        Creates an empty Sql tuning set within the Managed Database specified by managedDatabaseId.
        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

        Future<DropSqlTuningSetResponse> dropSqlTuningSet​(DropSqlTuningSetRequest request,
                                                  AsyncHandler<DropSqlTuningSetRequest,​DropSqlTuningSetResponse> handler)
        Drops the Sql tuning set specified by sqlTuningSet within the Managed Database specified by managedDatabaseId.
        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.

      • dropSqlsInSqlTuningSet

        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.

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

        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

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

      • listSqlTuningSets

        Future<ListSqlTuningSetsResponse> listSqlTuningSets​(ListSqlTuningSetsRequest request,
                                                    AsyncHandler<ListSqlTuningSetsRequest,​ListSqlTuningSetsResponse> handler)
        Lists the SQL tuning sets 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.

      • loadSqlTuningSet

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

        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’.
        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.

      • validateBasicFilter

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