SqlTuningClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.databasemanagement.SqlTuningClient

All Implemented Interfaces:: SqlTuning, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201101")
public class SqlTuningClient
extends Object
implements SqlTuning

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SqlTuningClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SqlTuningClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for SqlTuning.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for SqlTuning.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`SqlTuningClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`SqlTuningClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`SqlTuningClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SqlTuningClient.Builder`	`builder()` Create a builder for this client.
`CloneSqlTuningTaskResponse`	`cloneSqlTuningTask(CloneSqlTuningTaskRequest request)` Clones and runs a SQL tuning task in the database.
`void`	`close()`
`DropSqlTuningTaskResponse`	`dropSqlTuningTask(DropSqlTuningTaskRequest request)` 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)
`GetExecutionPlanStatsComparisionResponse`	`getExecutionPlanStatsComparision(GetExecutionPlanStatsComparisionRequest request)` Retrieves a comparison of the existing SQL execution plan and a new plan.
`SqlTuningPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetSqlExecutionPlanResponse`	`getSqlExecutionPlan(GetSqlExecutionPlanRequest request)` Retrieves a SQL execution plan for the SQL being tuned.
`GetSqlTuningAdvisorTaskSummaryReportResponse`	`getSqlTuningAdvisorTaskSummaryReport(GetSqlTuningAdvisorTaskSummaryReportRequest request)` Gets the summary report for the specified SQL Tuning Advisor task.
`ListSqlTuningAdvisorTaskFindingsResponse`	`listSqlTuningAdvisorTaskFindings(ListSqlTuningAdvisorTaskFindingsRequest request)` Gets an array of the details of the findings that match specific filters.
`ListSqlTuningAdvisorTaskRecommendationsResponse`	`listSqlTuningAdvisorTaskRecommendations(ListSqlTuningAdvisorTaskRecommendationsRequest request)` Gets the findings and possible actions for a given object in a SQL tuning task.
`ListSqlTuningAdvisorTasksResponse`	`listSqlTuningAdvisorTasks(ListSqlTuningAdvisorTasksRequest request)` Lists the SQL Tuning Advisor tasks for the specified Managed Database.
`ListSqlTuningSetsResponse`	`listSqlTuningSets(ListSqlTuningSetsRequest request)` Lists the SQL tuning sets for the specified Managed Database.
`void`	`refreshClient()` Rebuilds the client from scratch.
`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’).
`StartSqlTuningTaskResponse`	`startSqlTuningTask(StartSqlTuningTaskRequest request)` Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for SqlTuning.
- Constructor Detail
  - SqlTuningClient
```
public SqlTuningClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - SqlTuningClient
```
public SqlTuningClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - SqlTuningClient
```
public SqlTuningClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - SqlTuningClient
```
public SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - SqlTuningClient
```
public SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - SqlTuningClient
```
public SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - SqlTuningClient
```
public SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - SqlTuningClient
```
protected SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint,
                          RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed. Use the SqlTuningClient.Builder to get access to all these parameters.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static SqlTuningClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - refreshClient
```
public void refreshClient()
```
    Description copied from interface: SqlTuning
    
    Rebuilds the client from scratch. Useful to refresh certificates.
    
    Specified by:
    
    refreshClient in interface SqlTuning
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: SqlTuning
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface SqlTuning
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: SqlTuning
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface SqlTuning
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: SqlTuning
    
    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 SqlTuning
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: SqlTuning
    
    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 SqlTuning
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - cloneSqlTuningTask
```
public CloneSqlTuningTaskResponse cloneSqlTuningTask(CloneSqlTuningTaskRequest request)
```
    Description copied from interface: SqlTuning
    
    Clones and runs a SQL tuning task in the database.
    
    Specified by:
    
    cloneSqlTuningTask in interface SqlTuning
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - dropSqlTuningTask
```
public DropSqlTuningTaskResponse dropSqlTuningTask(DropSqlTuningTaskRequest request)
```
    Description copied from interface: SqlTuning
    
    Drops a SQL tuning task and its related results from the database.
    
    Specified by:
    
    dropSqlTuningTask in interface SqlTuning
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getExecutionPlanStatsComparision
```
public GetExecutionPlanStatsComparisionResponse getExecutionPlanStatsComparision(GetExecutionPlanStatsComparisionRequest request)
```
    Description copied from interface: SqlTuning
    
    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 SqlTuning
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSqlExecutionPlan
```
public GetSqlExecutionPlanResponse getSqlExecutionPlan(GetSqlExecutionPlanRequest request)
```
    Description copied from interface: SqlTuning
    
    Retrieves a SQL execution plan for the SQL being tuned.
    
    Specified by:
    
    getSqlExecutionPlan in interface SqlTuning
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSqlTuningAdvisorTaskSummaryReport
```
public GetSqlTuningAdvisorTaskSummaryReportResponse getSqlTuningAdvisorTaskSummaryReport(GetSqlTuningAdvisorTaskSummaryReportRequest request)
```
    Description copied from interface: SqlTuning
    
    Gets the summary report for the specified SQL Tuning Advisor task.
    
    Specified by:
    
    getSqlTuningAdvisorTaskSummaryReport in interface SqlTuning
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSqlTuningAdvisorTaskFindings
```
public ListSqlTuningAdvisorTaskFindingsResponse listSqlTuningAdvisorTaskFindings(ListSqlTuningAdvisorTaskFindingsRequest request)
```
    Description copied from interface: SqlTuning
    
    Gets an array of the details of the findings that match specific filters.
    
    Specified by:
    
    listSqlTuningAdvisorTaskFindings in interface SqlTuning
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSqlTuningAdvisorTaskRecommendations
```
public ListSqlTuningAdvisorTaskRecommendationsResponse listSqlTuningAdvisorTaskRecommendations(ListSqlTuningAdvisorTaskRecommendationsRequest request)
```
    Description copied from interface: SqlTuning
    
    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 SqlTuning
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSqlTuningAdvisorTasks
```
public ListSqlTuningAdvisorTasksResponse listSqlTuningAdvisorTasks(ListSqlTuningAdvisorTasksRequest request)
```
    Description copied from interface: SqlTuning
    
    Lists the SQL Tuning Advisor tasks for the specified Managed Database.
    
    Specified by:
    
    listSqlTuningAdvisorTasks in interface SqlTuning
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSqlTuningSets
```
public ListSqlTuningSetsResponse listSqlTuningSets(ListSqlTuningSetsRequest request)
```
    Description copied from interface: SqlTuning
    
    Lists the SQL tuning sets for the specified Managed Database.
    
    Specified by:
    
    listSqlTuningSets in interface SqlTuning
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - startSqlTuningTask
```
public StartSqlTuningTaskResponse startSqlTuningTask(StartSqlTuningTaskRequest request)
```
    Description copied from interface: SqlTuning
    
    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 SqlTuning
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getPaginators
```
public SqlTuningPaginators getPaginators()
```
    Description copied from interface: SqlTuning
    
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Specified by:
    
    getPaginators in interface SqlTuning
    
    Returns:
    
    The service paginators.

Class SqlTuningClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

SqlTuningClient

SqlTuningClient

SqlTuningClient

SqlTuningClient

SqlTuningClient

SqlTuningClient

SqlTuningClient

SqlTuningClient

Method Detail

builder

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

close

cloneSqlTuningTask

dropSqlTuningTask

getExecutionPlanStatsComparision

getSqlExecutionPlan

getSqlTuningAdvisorTaskSummaryReport

listSqlTuningAdvisorTaskFindings

listSqlTuningAdvisorTaskRecommendations

listSqlTuningAdvisorTasks

listSqlTuningSets

startSqlTuningTask

getPaginators