Package com.oracle.bmc.databasemanagement.model

Class SqlPlanBaseline

java.lang.Object

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

com.oracle.bmc.databasemanagement.model.SqlPlanBaseline

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

The details of a SQL plan baseline.
Note: Objects should always be created or deserialized using the SqlPlanBaseline.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 SqlPlanBaseline.Builder, which maintain a set of all explicitly set fields called SqlPlanBaseline.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	SqlPlanBaseline.Accepted	Indicates whether the plan baseline is accepted (YES) or not (NO).
static class	SqlPlanBaseline.Adaptive	Indicates whether a plan that is automatically captured by SQL plan management is marked adaptive or not.
static class	SqlPlanBaseline.AutoPurge	Indicates whether the plan baseline is auto-purged (YES) or not (NO).
static class	SqlPlanBaseline.Builder
static class	SqlPlanBaseline.Enabled	Indicates whether the plan baseline is enabled (YES) or disabled (NO).
static class	SqlPlanBaseline.Fixed	Indicates whether the plan baseline is fixed (YES) or not (NO).
static class	SqlPlanBaseline.Reproduced	Indicates whether the optimizer was able to reproduce the plan (YES) or not ( NO).

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

SqlPlanBaseline(String planName, String sqlHandle, String sqlText, SqlPlanBaselineOrigin origin, Date timeCreated, Date timeLastModified, Date timeLastExecuted, SqlPlanBaseline.Enabled enabled, SqlPlanBaseline.Accepted accepted, SqlPlanBaseline.Fixed fixed, SqlPlanBaseline.Reproduced reproduced, SqlPlanBaseline.AutoPurge autoPurge, SqlPlanBaseline.Adaptive adaptive, String module, String action, String executionPlan)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static SqlPlanBaseline.Builder	builder()	Create a new builder.
boolean	equals(Object o)
SqlPlanBaseline.Accepted	getAccepted()	Indicates whether the plan baseline is accepted (YES) or not (NO).
String	getAction()	The application action.
SqlPlanBaseline.Adaptive	getAdaptive()	Indicates whether a plan that is automatically captured by SQL plan management is marked adaptive or not.
SqlPlanBaseline.AutoPurge	getAutoPurge()	Indicates whether the plan baseline is auto-purged (YES) or not (NO).
SqlPlanBaseline.Enabled	getEnabled()	Indicates whether the plan baseline is enabled (YES) or disabled (NO).
String	getExecutionPlan()	The execution plan for the SQL statement.
SqlPlanBaseline.Fixed	getFixed()	Indicates whether the plan baseline is fixed (YES) or not (NO).
String	getModule()	The application module name.
SqlPlanBaselineOrigin	getOrigin()	The origin of the SQL plan baseline.
String	getPlanName()	The unique plan identifier.
SqlPlanBaseline.Reproduced	getReproduced()	Indicates whether the optimizer was able to reproduce the plan (YES) or not ( NO).
String	getSqlHandle()	The unique SQL identifier.
String	getSqlText()	The SQL text.
Date	getTimeCreated()	The date and time when the plan baseline was created.
Date	getTimeLastExecuted()	The date and time when the plan baseline was last executed.
Date	getTimeLastModified()	The date and time when the plan baseline was last modified.
int	hashCode()
SqlPlanBaseline.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

SqlPlanBaseline

@Deprecated
@ConstructorProperties({"planName","sqlHandle","sqlText","origin","timeCreated","timeLastModified","timeLastExecuted","enabled","accepted","fixed","reproduced","autoPurge","adaptive","module","action","executionPlan"})
public SqlPlanBaseline(String planName,
                       String sqlHandle,
                       String sqlText,
                       SqlPlanBaselineOrigin origin,
                       Date timeCreated,
                       Date timeLastModified,
                       Date timeLastExecuted,
                       SqlPlanBaseline.Enabled enabled,
                       SqlPlanBaseline.Accepted accepted,
                       SqlPlanBaseline.Fixed fixed,
                       SqlPlanBaseline.Reproduced reproduced,
                       SqlPlanBaseline.AutoPurge autoPurge,
                       SqlPlanBaseline.Adaptive adaptive,
                       String module,
                       String action,
                       String executionPlan)

Deprecated.

Method Detail

builder

public static SqlPlanBaseline.Builder builder()

Create a new builder.

toBuilder

public SqlPlanBaseline.Builder toBuilder()

getPlanName

public String getPlanName()

The unique plan identifier.

Returns:

the value

getSqlHandle

public String getSqlHandle()

The unique SQL identifier.

Returns:

the value

getSqlText

public String getSqlText()

The SQL text.

Returns:

the value

getOrigin

public SqlPlanBaselineOrigin getOrigin()

The origin of the SQL plan baseline.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time when the plan baseline was created.

Returns:

the value

getTimeLastModified

public Date getTimeLastModified()

The date and time when the plan baseline was last modified.

Returns:

the value

getTimeLastExecuted

public Date getTimeLastExecuted()

The date and time when the plan baseline was last executed.

*Note:** For performance reasons, database does not update this value immediately after each execution of the plan baseline. Therefore, the plan baseline may have been executed more recently than this value indicates.

Returns:

the value

getEnabled

public SqlPlanBaseline.Enabled getEnabled()

Indicates whether the plan baseline is enabled (YES) or disabled (NO).

Returns:

the value

getAccepted

public SqlPlanBaseline.Accepted getAccepted()

Indicates whether the plan baseline is accepted (YES) or not (NO).

Returns:

the value

getFixed

public SqlPlanBaseline.Fixed getFixed()

Indicates whether the plan baseline is fixed (YES) or not (NO).

Returns:

the value

getReproduced

public SqlPlanBaseline.Reproduced getReproduced()

Indicates whether the optimizer was able to reproduce the plan (YES) or not ( NO).

The value is set to YES when a plan is initially added to the plan baseline.

Returns:

the value

getAutoPurge

public SqlPlanBaseline.AutoPurge getAutoPurge()

Indicates whether the plan baseline is auto-purged (YES) or not (NO).

Returns:

the value

getAdaptive

public SqlPlanBaseline.Adaptive getAdaptive()

Indicates whether a plan that is automatically captured by SQL plan management is marked adaptive or not.

When a new adaptive plan is found for a SQL statement that has an existing SQL plan baseline, that new plan will be added to the SQL plan baseline as an unaccepted plan, and the ADAPTIVE property will be marked YES. When this new plan is verified (either manually or via the auto evolve task), the plan will be test executed and the final plan determined at execution will become an accepted plan if its performance is better than the existing plan baseline. At this point, the value of the ADAPTIVE property is set to NO since the plan is no longer adaptive, but resolved.

Returns:

the value

getModule

public String getModule()

The application module name.

Returns:

the value

getAction

public String getAction()

The application action.

Returns:

the value

getExecutionPlan

public String getExecutionPlan()

The execution plan for the SQL statement.

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