StartSqlTuningTaskDetails

class oci.database_management.models.StartSqlTuningTaskDetails(**kwargs)

Bases: object

The request to start a SQL tuning task. It takes either credentialDetails or databaseCredential. It’s recommended to provide databaseCredential

Attributes:

SCOPE_COMPREHENSIVE

A constant which can be used with the scope property of a StartSqlTuningTaskDetails.

SCOPE_LIMITED

A constant which can be used with the scope property of a StartSqlTuningTaskDetails.

credential_details

Gets the credential_details of this StartSqlTuningTaskDetails.

database_credential

Gets the database_credential of this StartSqlTuningTaskDetails.

scope

[Required] Gets the scope of this StartSqlTuningTaskDetails.

sql_details

Gets the sql_details of this StartSqlTuningTaskDetails.

sql_tuning_set

Gets the sql_tuning_set of this StartSqlTuningTaskDetails.

statement_time_limit_in_minutes

Gets the statement_time_limit_in_minutes of this StartSqlTuningTaskDetails.

task_description

Gets the task_description of this StartSqlTuningTaskDetails.

task_name

[Required] Gets the task_name of this StartSqlTuningTaskDetails.

time_ended

Gets the time_ended of this StartSqlTuningTaskDetails.

time_started

Gets the time_started of this StartSqlTuningTaskDetails.

total_time_limit_in_minutes

[Required] Gets the total_time_limit_in_minutes of this StartSqlTuningTaskDetails.

Methods:

__init__(**kwargs)

Initializes a new StartSqlTuningTaskDetails object with values from keyword arguments.

SCOPE_COMPREHENSIVE = 'COMPREHENSIVE'

A constant which can be used with the scope property of a StartSqlTuningTaskDetails. This constant has a value of “COMPREHENSIVE”

SCOPE_LIMITED = 'LIMITED'

A constant which can be used with the scope property of a StartSqlTuningTaskDetails. This constant has a value of “LIMITED”

__init__(**kwargs)

Initializes a new StartSqlTuningTaskDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • task_name (str) – The value to assign to the task_name property of this StartSqlTuningTaskDetails.

  • task_description (str) – The value to assign to the task_description property of this StartSqlTuningTaskDetails.

  • credential_details (oci.database_management.models.SqlTuningTaskCredentialDetails) – The value to assign to the credential_details property of this StartSqlTuningTaskDetails.

  • database_credential (oci.database_management.models.DatabaseCredentialDetails) – The value to assign to the database_credential property of this StartSqlTuningTaskDetails.

  • total_time_limit_in_minutes (int) – The value to assign to the total_time_limit_in_minutes property of this StartSqlTuningTaskDetails.

  • scope (str) – The value to assign to the scope property of this StartSqlTuningTaskDetails. Allowed values for this property are: “LIMITED”, “COMPREHENSIVE”

  • statement_time_limit_in_minutes (int) – The value to assign to the statement_time_limit_in_minutes property of this StartSqlTuningTaskDetails.

  • sql_tuning_set (oci.database_management.models.SqlTuningSetInput) – The value to assign to the sql_tuning_set property of this StartSqlTuningTaskDetails.

  • sql_details (list[oci.database_management.models.SqlTuningTaskSqlDetail]) – The value to assign to the sql_details property of this StartSqlTuningTaskDetails.

  • time_started (datetime) – The value to assign to the time_started property of this StartSqlTuningTaskDetails.

  • time_ended (datetime) – The value to assign to the time_ended property of this StartSqlTuningTaskDetails.

property credential_details

Gets the credential_details of this StartSqlTuningTaskDetails.

Returns

The credential_details of this StartSqlTuningTaskDetails.

Return type

oci.database_management.models.SqlTuningTaskCredentialDetails

property database_credential

Gets the database_credential of this StartSqlTuningTaskDetails.

Returns

The database_credential of this StartSqlTuningTaskDetails.

Return type

oci.database_management.models.DatabaseCredentialDetails

property scope

[Required] Gets the scope of this StartSqlTuningTaskDetails. 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.

Allowed values for this property are: “LIMITED”, “COMPREHENSIVE”

Returns

The scope of this StartSqlTuningTaskDetails.

Return type

str

property sql_details

Gets the sql_details of this StartSqlTuningTaskDetails. 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 sql_details of this StartSqlTuningTaskDetails.

Return type

list[oci.database_management.models.SqlTuningTaskSqlDetail]

property sql_tuning_set

Gets the sql_tuning_set of this StartSqlTuningTaskDetails.

Returns

The sql_tuning_set of this StartSqlTuningTaskDetails.

Return type

oci.database_management.models.SqlTuningSetInput

property statement_time_limit_in_minutes

Gets the statement_time_limit_in_minutes of this StartSqlTuningTaskDetails. 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 statement_time_limit_in_minutes of this StartSqlTuningTaskDetails.

Return type

int

property task_description

Gets the task_description of this StartSqlTuningTaskDetails. The description of the SQL tuning task.

Returns

The task_description of this StartSqlTuningTaskDetails.

Return type

str

property task_name

[Required] Gets the task_name of this StartSqlTuningTaskDetails. The name of the SQL tuning task. The name is unique per user in a database, and it is case-sensitive.

Returns

The task_name of this StartSqlTuningTaskDetails.

Return type

str

property time_ended

Gets the time_ended of this StartSqlTuningTaskDetails. The end time of the period in which SQL statements are running.

Returns

The time_ended of this StartSqlTuningTaskDetails.

Return type

datetime

property time_started

Gets the time_started of this StartSqlTuningTaskDetails. The start time of the period in which SQL statements are running.

Returns

The time_started of this StartSqlTuningTaskDetails.

Return type

datetime

property total_time_limit_in_minutes

[Required] Gets the total_time_limit_in_minutes of this StartSqlTuningTaskDetails. The time limit for running the SQL tuning task.

Returns

The total_time_limit_in_minutes of this StartSqlTuningTaskDetails.

Return type

int