com.oracle.bmc.databasemanagement

Class SqlTuningClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.databasemanagement.SqlTuningClient

All Implemented Interfaces:

SqlTuning, AutoCloseable

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

Nested Class Summary

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
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 and Description
SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
SqlTuningClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
SqlTuningClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
SqlTuningClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
SqlTuningClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

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()
CreateSqlTuningSetResponse	createSqlTuningSet(CreateSqlTuningSetRequest request) Creates an empty Sql tuning set within the Managed Database specified by managedDatabaseId.
DropSqlsInSqlTuningSetResponse	dropSqlsInSqlTuningSet(DropSqlsInSqlTuningSetRequest request) Deletes the Sqls in the specified Sql tuning set that matches the filter criteria provided in the basicFilter.
DropSqlTuningSetResponse	dropSqlTuningSet(DropSqlTuningSetRequest request) Drops the Sql tuning set specified by sqlTuningSet within the Managed Database specified by managedDatabaseId.
DropSqlTuningTaskResponse	dropSqlTuningTask(DropSqlTuningTaskRequest request) Drops a SQL tuning task and its related results from the database.
FetchSqlTuningSetResponse	fetchSqlTuningSet(FetchSqlTuningSetRequest request) 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()
GetExecutionPlanStatsComparisionResponse	getExecutionPlanStatsComparision(GetExecutionPlanStatsComparisionRequest request) Retrieves a comparison of the existing SQL execution plan and a new plan.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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.
LoadSqlTuningSetResponse	loadSqlTuningSet(LoadSqlTuningSetRequest request) 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.
SaveSqlTuningSetAsResponse	saveSqlTuningSetAs(SaveSqlTuningSetAsRequest request) 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’).
StartSqlTuningTaskResponse	startSqlTuningTask(StartSqlTuningTaskRequest request) 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.
ValidateBasicFilterResponse	validateBasicFilter(ValidateBasicFilterRequest request) Executes a SQL query to check whether user entered basic filter criteria is valid or not.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.databasemanagement.SqlTuning

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

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

SqlTuningClient

@Deprecated
public SqlTuningClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

SqlTuningClient

@Deprecated
public SqlTuningClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

SqlTuningClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

SqlTuningClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

SqlTuningClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

SqlTuningClient

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

SqlTuningClient

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

Create a builder for this client.

Returns:

builder

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.

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

createSqlTuningSet

public CreateSqlTuningSetResponse createSqlTuningSet(CreateSqlTuningSetRequest request)

Description copied from interface: SqlTuning

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

Specified by:

createSqlTuningSet in interface SqlTuning

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

dropSqlTuningSet

public DropSqlTuningSetResponse dropSqlTuningSet(DropSqlTuningSetRequest request)

Description copied from interface: SqlTuning

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

Specified by:

dropSqlTuningSet 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

dropSqlsInSqlTuningSet

public DropSqlsInSqlTuningSetResponse dropSqlsInSqlTuningSet(DropSqlsInSqlTuningSetRequest request)

Description copied from interface: SqlTuning

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 SqlTuning

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

fetchSqlTuningSet

public FetchSqlTuningSetResponse fetchSqlTuningSet(FetchSqlTuningSetRequest request)

Description copied from interface: SqlTuning

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

Specified by:

fetchSqlTuningSet 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

loadSqlTuningSet

public LoadSqlTuningSetResponse loadSqlTuningSet(LoadSqlTuningSetRequest request)

Description copied from interface: SqlTuning

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 SqlTuning

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

saveSqlTuningSetAs

public SaveSqlTuningSetAsResponse saveSqlTuningSetAs(SaveSqlTuningSetAsRequest request)

Description copied from interface: SqlTuning

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

validateBasicFilter

public ValidateBasicFilterResponse validateBasicFilter(ValidateBasicFilterRequest request)

Description copied from interface: SqlTuning

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

Specified by:

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

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()