com.oracle.bmc.databasemanagement.model

Class LoadSqlTuningSetDetails.Builder

java.lang.Object

com.oracle.bmc.databasemanagement.model.LoadSqlTuningSetDetails.Builder

Enclosing class:

LoadSqlTuningSetDetails

public static class LoadSqlTuningSetDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
LoadSqlTuningSetDetails.Builder	attributeList(String attributeList) Specifies the list of Sql statement attributes to return in the result.
LoadSqlTuningSetDetails.Builder	baselineName(String baselineName) Specifies the name of the AWR baseline period.
LoadSqlTuningSetDetails.Builder	basicFilter(String basicFilter) Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW.
LoadSqlTuningSetDetails.Builder	beginSnapshot(Long beginSnapshot) Defines the beginning AWR snapshot (non-inclusive).
LoadSqlTuningSetDetails	build()
LoadSqlTuningSetDetails.Builder	captureMode(LoadSqlTuningSetDetails.CaptureMode captureMode) Specifies the capture mode.
LoadSqlTuningSetDetails.Builder	captureOption(LoadSqlTuningSetDetails.CaptureOption captureOption) Specifies whether to insert new statements, update existing statements, or both.
LoadSqlTuningSetDetails.Builder	commitRows(Integer commitRows) Specifies whether to commit statements after DML.
LoadSqlTuningSetDetails.Builder	copy(LoadSqlTuningSetDetails model)
LoadSqlTuningSetDetails.Builder	credentialDetails(SqlTuningSetAdminCredentialDetails credentialDetails)
LoadSqlTuningSetDetails.Builder	databaseCredential(DatabaseCredentialDetails databaseCredential)
LoadSqlTuningSetDetails.Builder	endSnapshot(Long endSnapshot) Defines the ending AWR snapshot (inclusive).
LoadSqlTuningSetDetails.Builder	isIgnoreNull(Boolean isIgnoreNull) Specifies whether to update attributes when the new value is NULL.
LoadSqlTuningSetDetails.Builder	loadOption(LoadSqlTuningSetDetails.LoadOption loadOption) Specifies which statements are loaded into the Sql tuning set.
LoadSqlTuningSetDetails.Builder	loadType(LoadSqlTuningSetDetails.LoadType loadType) Specifies the loading method into the Sql tuning set.
LoadSqlTuningSetDetails.Builder	name(String name) The name of the Sql tuning set.
LoadSqlTuningSetDetails.Builder	owner(String owner) The owner of the Sql tuning set.
LoadSqlTuningSetDetails.Builder	rankingMeasure1(RankingMeasure rankingMeasure1) Specifies an ORDER BY clause on the selected Sql.
LoadSqlTuningSetDetails.Builder	rankingMeasure2(RankingMeasure rankingMeasure2) Specifies an ORDER BY clause on the selected Sql.
LoadSqlTuningSetDetails.Builder	rankingMeasure3(RankingMeasure rankingMeasure3) Specifies an ORDER BY clause on the selected Sql.
LoadSqlTuningSetDetails.Builder	recursiveSql(LoadSqlTuningSetDetails.RecursiveSql recursiveSql) Specifies that the filter must include recursive Sql in the Sql tuning set.
LoadSqlTuningSetDetails.Builder	repeatInterval(Integer repeatInterval) Defines the amount of time, in seconds, to pause between sampling.
LoadSqlTuningSetDetails.Builder	resultLimit(Integer resultLimit) The top limit Sql from the filtered source, ranked by the ranking measure.
LoadSqlTuningSetDetails.Builder	resultPercentage(Double resultPercentage) Specifies a filter that picks the top n% according to the supplied ranking measure.
LoadSqlTuningSetDetails.Builder	showSqlOnly(Integer showSqlOnly) Flag to indicate whether to create the Sql tuning set or just display the plsql used to create Sql tuning set.
LoadSqlTuningSetDetails.Builder	totalTimeLimit(Integer totalTimeLimit) Defines the total amount of time, in seconds, to execute.
LoadSqlTuningSetDetails.Builder	updateAttributes(String updateAttributes) Specifies the list of Sql statement attributes to update during a merge or update.
LoadSqlTuningSetDetails.Builder	updateCondition(LoadSqlTuningSetDetails.UpdateCondition updateCondition) Specifies when to perform the update.
LoadSqlTuningSetDetails.Builder	updateOption(LoadSqlTuningSetDetails.UpdateOption updateOption) Specifies how existing Sql statements are updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

credentialDetails

public LoadSqlTuningSetDetails.Builder credentialDetails(SqlTuningSetAdminCredentialDetails credentialDetails)

databaseCredential

public LoadSqlTuningSetDetails.Builder databaseCredential(DatabaseCredentialDetails databaseCredential)

showSqlOnly

public LoadSqlTuningSetDetails.Builder showSqlOnly(Integer showSqlOnly)

Flag to indicate whether to create the Sql tuning set or just display the plsql used to create Sql tuning set.

Parameters:

showSqlOnly - the value to set

Returns:

this builder

owner

public LoadSqlTuningSetDetails.Builder owner(String owner)

The owner of the Sql tuning set.

Parameters:

owner - the value to set

Returns:

this builder

name

public LoadSqlTuningSetDetails.Builder name(String name)

The name of the Sql tuning set.

Parameters:

name - the value to set

Returns:

this builder

loadType

public LoadSqlTuningSetDetails.Builder loadType(LoadSqlTuningSetDetails.LoadType loadType)

Specifies the loading method into the Sql tuning set.

Parameters:

loadType - the value to set

Returns:

this builder

basicFilter

public LoadSqlTuningSetDetails.Builder basicFilter(String basicFilter)

Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. User could use any combination of the following columns with appropriate values as Sql predicate Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C

Parameters:

basicFilter - the value to set

Returns:

this builder

recursiveSql

public LoadSqlTuningSetDetails.Builder recursiveSql(LoadSqlTuningSetDetails.RecursiveSql recursiveSql)

Specifies that the filter must include recursive Sql in the Sql tuning set.

Parameters:

recursiveSql - the value to set

Returns:

this builder

resultPercentage

public LoadSqlTuningSetDetails.Builder resultPercentage(Double resultPercentage)

Specifies a filter that picks the top n% according to the supplied ranking measure. Note that this parameter applies only if one ranking measure is supplied.

Parameters:

resultPercentage - the value to set

Returns:

this builder

resultLimit

public LoadSqlTuningSetDetails.Builder resultLimit(Integer resultLimit)

The top limit Sql from the filtered source, ranked by the ranking measure.

Parameters:

resultLimit - the value to set

Returns:

this builder

rankingMeasure1

public LoadSqlTuningSetDetails.Builder rankingMeasure1(RankingMeasure rankingMeasure1)

Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures.

Parameters:

rankingMeasure1 - the value to set

Returns:

this builder

rankingMeasure2

public LoadSqlTuningSetDetails.Builder rankingMeasure2(RankingMeasure rankingMeasure2)

Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures.

Parameters:

rankingMeasure2 - the value to set

Returns:

this builder

rankingMeasure3

public LoadSqlTuningSetDetails.Builder rankingMeasure3(RankingMeasure rankingMeasure3)

Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures.

Parameters:

rankingMeasure3 - the value to set

Returns:

this builder

totalTimeLimit

public LoadSqlTuningSetDetails.Builder totalTimeLimit(Integer totalTimeLimit)

Defines the total amount of time, in seconds, to execute.

Parameters:

totalTimeLimit - the value to set

Returns:

this builder

repeatInterval

public LoadSqlTuningSetDetails.Builder repeatInterval(Integer repeatInterval)

Defines the amount of time, in seconds, to pause between sampling.

Parameters:

repeatInterval - the value to set

Returns:

this builder

captureOption

public LoadSqlTuningSetDetails.Builder captureOption(LoadSqlTuningSetDetails.CaptureOption captureOption)

Specifies whether to insert new statements, update existing statements, or both.

Parameters:

captureOption - the value to set

Returns:

this builder

captureMode

public LoadSqlTuningSetDetails.Builder captureMode(LoadSqlTuningSetDetails.CaptureMode captureMode)

Specifies the capture mode. Note that this parameter is applicable only for UPDATE and MERGE capture options. Capture mode can take one of the following values - MODE_REPLACE_OLD_STATS Replaces statistics when the number of executions is greater than the number stored in the Sql tuning set - MODE_ACCUMULATE_STATS Adds new values to current values for Sql that is already stored. Note that this mode detects if a statement has been aged out, so the final value for a statistics is the sum of the statistics of all cursors that statement existed under.

Parameters:

captureMode - the value to set

Returns:

this builder

attributeList

public LoadSqlTuningSetDetails.Builder attributeList(String attributeList)

Specifies the list of Sql statement attributes to return in the result. Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. Attribute list can take one of the following values. TYPICAL - Specifies BASIC plus Sql plan (without row source statistics) and without object reference list (default). BASIC - Specifies all attributes (such as execution statistics and binds) except the plans. The execution context is always part of the result. ALL - Specifies all attributes. CUSTOM - Comma-separated list of the following attribute names. - EXECUTION_STATISTICS - BIND_LIST - OBJECT_LIST - SQL_PLAN - SQL_PLAN_STATISTICS Usage examples: 1. “attributeList”: “TYPICAL” 2. “attributeList”: “ALL” 3. “attributeList”: “EXECUTION_STATISTICS,OBJECT_LIST,SQL_PLAN”

Parameters:

attributeList - the value to set

Returns:

this builder

loadOption

public LoadSqlTuningSetDetails.Builder loadOption(LoadSqlTuningSetDetails.LoadOption loadOption)

Specifies which statements are loaded into the Sql tuning set. The possible values are. - INSERT (default) Adds only new statements. - UPDATE Updates existing the Sql statements and ignores any new statements. - MERGE Inserts new statements and updates the information of the existing ones.

Parameters:

loadOption - the value to set

Returns:

this builder

updateOption

public LoadSqlTuningSetDetails.Builder updateOption(LoadSqlTuningSetDetails.UpdateOption updateOption)

Specifies how existing Sql statements are updated. This parameter is applicable only if load_option is specified with UPDATE or MERGE as an option. Update option can take one of the following values. REPLACE (default) - Updates the statement using the new statistics, bind list, object list, and so on. ACCUMULATE - Combines attributes when possible (for example, statistics such as elapsed_time), otherwise replaces the existing values (for example, module and action) with the provided values. Following Sql statement attributes can be accumulated. elapsed_time buffer_gets direct_writes disk_reads row_processed fetches executions end_of_fetch_count stat_period active_stat_period

Parameters:

updateOption - the value to set

Returns:

this builder

updateAttributes

public LoadSqlTuningSetDetails.Builder updateAttributes(String updateAttributes)

Specifies the list of Sql statement attributes to update during a merge or update. Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. Update attributes can take one of the following values. NULL (default) - Specifies the content of the input cursor except the execution context. On other terms, it is equivalent to ALL without execution contexts such as module and action. BASIC - Specifies statistics and binds only. TYPICAL - Specifies BASIC with Sql plans (without row source statistics) and without an object reference list. ALL - Specifies all attributes, including the execution context attributes such as module and action. CUSTOM - List of comma separated attribute names to update EXECUTION_CONTEXT EXECUTION_STATISTICS SQL_BINDS SQL_PLAN SQL_PLAN_STATISTICS (similar to SQL_PLAN with added row source statistics) Usage examples: 1. “updateAttributes”: “TYPICAL” 2. “updateAttributes”: “BASIC” 3. “updateAttributes”: “EXECUTION_STATISTICS,SQL_PLAN_STATISTICS,SQL_PLAN” 4. “updateAttributes”: “EXECUTION_STATISTICS,SQL_PLAN”

Parameters:

updateAttributes - the value to set

Returns:

this builder

updateCondition

public LoadSqlTuningSetDetails.Builder updateCondition(LoadSqlTuningSetDetails.UpdateCondition updateCondition)

Specifies when to perform the update. The procedure only performs the update when the specified condition is satisfied. The condition can refer to either the data source or destination. The condition must use the following prefixes to refer to attributes from the source or the destination: OLD — Refers to statement attributes from the SQL tuning set (destination). NEW — Refers to statement attributes from the input statements (source). NULL — No updates are performed.

Parameters:

updateCondition - the value to set

Returns:

this builder

isIgnoreNull

public LoadSqlTuningSetDetails.Builder isIgnoreNull(Boolean isIgnoreNull)

Specifies whether to update attributes when the new value is NULL. If TRUE, then the procedure does not update an attribute when the new value is NULL. That is, do not override with NULL values unless intentional. Possible values - true or false

Parameters:

isIgnoreNull - the value to set

Returns:

this builder

commitRows

public LoadSqlTuningSetDetails.Builder commitRows(Integer commitRows)

Specifies whether to commit statements after DML. If a value is provided, then the load commits after each specified number of statements is inserted. If NULL is provided, then the load commits only once, at the end of the operation.

Parameters:

commitRows - the value to set

Returns:

this builder

beginSnapshot

public LoadSqlTuningSetDetails.Builder beginSnapshot(Long beginSnapshot)

Defines the beginning AWR snapshot (non-inclusive).

Parameters:

beginSnapshot - the value to set

Returns:

this builder

endSnapshot

public LoadSqlTuningSetDetails.Builder endSnapshot(Long endSnapshot)

Defines the ending AWR snapshot (inclusive).

Parameters:

endSnapshot - the value to set

Returns:

this builder

baselineName

public LoadSqlTuningSetDetails.Builder baselineName(String baselineName)

Specifies the name of the AWR baseline period. When loading the sql statements from AWR, following inputs has to be provided: beginSnapshot and endSnapshot OR baselineName

Parameters:

baselineName - the value to set

Returns:

this builder

build

public LoadSqlTuningSetDetails build()

copy

public LoadSqlTuningSetDetails.Builder copy(LoadSqlTuningSetDetails model)