Package com.oracle.bmc.databasemanagement.model

Class StartSqlTuningTaskDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.databasemanagement.model.StartSqlTuningTaskDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201101")
public final class StartSqlTuningTaskDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The request to start a SQL tuning task.

It takes either credentialDetails or databaseCredential. It’s recommended to provide databaseCredential
Note: Objects should always be created or deserialized using the StartSqlTuningTaskDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the StartSqlTuningTaskDetails.Builder, which maintain a set of all explicitly set fields called StartSqlTuningTaskDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StartSqlTuningTaskDetails.Builder
static class	StartSqlTuningTaskDetails.Scope	The scope for the SQL tuning task.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
StartSqlTuningTaskDetails(String taskName, String taskDescription, SqlTuningTaskCredentialDetails credentialDetails, DatabaseCredentialDetails databaseCredential, Integer totalTimeLimitInMinutes, StartSqlTuningTaskDetails.Scope scope, Integer statementTimeLimitInMinutes, SqlTuningSetInput sqlTuningSet, List<SqlTuningTaskSqlDetail> sqlDetails, Date timeStarted, Date timeEnded)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static StartSqlTuningTaskDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
SqlTuningTaskCredentialDetails	getCredentialDetails()
DatabaseCredentialDetails	getDatabaseCredential()
StartSqlTuningTaskDetails.Scope	getScope()	The scope for the SQL tuning task.
List<SqlTuningTaskSqlDetail>	getSqlDetails()	The details of the SQL statement on which tuning is performed.
SqlTuningSetInput	getSqlTuningSet()
Integer	getStatementTimeLimitInMinutes()	The time limit per SQL statement (in minutes).
String	getTaskDescription()	The description of the SQL tuning task.
String	getTaskName()	The name of the SQL tuning task.
Date	getTimeEnded()	The end time of the period in which SQL statements are running.
Date	getTimeStarted()	The start time of the period in which SQL statements are running.
Integer	getTotalTimeLimitInMinutes()	The time limit for running the SQL tuning task.
int	hashCode()
StartSqlTuningTaskDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartSqlTuningTaskDetails

@Deprecated
@ConstructorProperties({"taskName","taskDescription","credentialDetails","databaseCredential","totalTimeLimitInMinutes","scope","statementTimeLimitInMinutes","sqlTuningSet","sqlDetails","timeStarted","timeEnded"})
public StartSqlTuningTaskDetails(String taskName,
                                 String taskDescription,
                                 SqlTuningTaskCredentialDetails credentialDetails,
                                 DatabaseCredentialDetails databaseCredential,
                                 Integer totalTimeLimitInMinutes,
                                 StartSqlTuningTaskDetails.Scope scope,
                                 Integer statementTimeLimitInMinutes,
                                 SqlTuningSetInput sqlTuningSet,
                                 List<SqlTuningTaskSqlDetail> sqlDetails,
                                 Date timeStarted,
                                 Date timeEnded)

Deprecated.

Method Detail

builder

public static StartSqlTuningTaskDetails.Builder builder()

Create a new builder.

toBuilder

public StartSqlTuningTaskDetails.Builder toBuilder()

getTaskName

public String getTaskName()

The name of the SQL tuning task.

The name is unique per user in a database, and it is case-sensitive.

Returns:

the value

getTaskDescription

public String getTaskDescription()

The description of the SQL tuning task.

Returns:

the value

getCredentialDetails

public SqlTuningTaskCredentialDetails getCredentialDetails()

getDatabaseCredential

public DatabaseCredentialDetails getDatabaseCredential()

getTotalTimeLimitInMinutes

public Integer getTotalTimeLimitInMinutes()

The time limit for running the SQL tuning task.

Returns:

the value

getScope

public StartSqlTuningTaskDetails.Scope getScope()

The scope for the SQL tuning task.

For LIMITED scope, the SQL profile recommendation is excluded, so the task is executed faster. For COMPREHENSIVE scope, the SQL profile recommendation is included.

Returns:

the value

getStatementTimeLimitInMinutes

public Integer getStatementTimeLimitInMinutes()

The time limit per SQL statement (in minutes).

This is for a task with the COMPREHENSIVE scope. The time limit per SQL statement should not be more than the total time limit.

Returns:

the value

getSqlTuningSet

public SqlTuningSetInput getSqlTuningSet()

getSqlDetails

public List<SqlTuningTaskSqlDetail> getSqlDetails()

The details of the SQL statement on which tuning is performed.

To obtain the details of the SQL statement, you must provide either the sqlTuningSet or the tuple of sqlDetails/timeStarted/timeEnded.

Returns:

the value

getTimeStarted

public Date getTimeStarted()

The start time of the period in which SQL statements are running.

Returns:

the value

getTimeEnded

public Date getTimeEnded()

The end time of the period in which SQL statements are running.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel