Class StartSqlTuningTaskDetails

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

Inheritance

object

StartSqlTuningTaskDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatabasemanagementService.Models

Assembly: OCI.DotNetSDK.Databasemanagement.dll

Syntax

public class StartSqlTuningTaskDetails

Properties

CredentialDetails

Declaration

[JsonProperty(PropertyName = "credentialDetails")]
public SqlTuningTaskCredentialDetails CredentialDetails { get; set; }

Property Value

Type	Description
SqlTuningTaskCredentialDetails

DatabaseCredential

Declaration

[JsonProperty(PropertyName = "databaseCredential")]
public DatabaseCredentialDetails DatabaseCredential { get; set; }

Property Value

Type	Description
DatabaseCredentialDetails

Scope

Declaration

[Required(ErrorMessage = "Scope is required.")]
[JsonProperty(PropertyName = "scope")]
[JsonConverter(typeof(StringEnumConverter))]
public StartSqlTuningTaskDetails.ScopeEnum? Scope { get; set; }

Property Value

Type	Description
StartSqlTuningTaskDetails.ScopeEnum?	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.

Remarks

Required

SqlDetails

Declaration

[JsonProperty(PropertyName = "sqlDetails")]
public List<SqlTuningTaskSqlDetail> SqlDetails { get; set; }

Property Value

Type	Description
List<SqlTuningTaskSqlDetail>	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.

SqlTuningSet

Declaration

[JsonProperty(PropertyName = "sqlTuningSet")]
public SqlTuningSetInput SqlTuningSet { get; set; }

Property Value

Type	Description
SqlTuningSetInput

StatementTimeLimitInMinutes

Declaration

[JsonProperty(PropertyName = "statementTimeLimitInMinutes")]
public int? StatementTimeLimitInMinutes { get; set; }

Property Value

Type	Description
int?	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.

TaskDescription

Declaration

[JsonProperty(PropertyName = "taskDescription")]
public string TaskDescription { get; set; }

Property Value

Type	Description
string	The description of the SQL tuning task.

TaskName

Declaration

[Required(ErrorMessage = "TaskName is required.")]
[JsonProperty(PropertyName = "taskName")]
public string TaskName { get; set; }

Property Value

Type	Description
string	The name of the SQL tuning task. The name is unique per user in a database, and it is case-sensitive.

Remarks

Required

TimeEnded

Declaration

[JsonProperty(PropertyName = "timeEnded")]
public DateTime? TimeEnded { get; set; }

Property Value

Type	Description
DateTime?	The end time of the period in which SQL statements are running.

TimeStarted

Declaration

[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }

Property Value

Type	Description
DateTime?	The start time of the period in which SQL statements are running.

TotalTimeLimitInMinutes

Declaration

[Required(ErrorMessage = "TotalTimeLimitInMinutes is required.")]
[JsonProperty(PropertyName = "totalTimeLimitInMinutes")]
public int? TotalTimeLimitInMinutes { get; set; }

Property Value

Type	Description
int?	The time limit for running the SQL tuning task.

Remarks

Required