Class DatabaseToolsSqlReport

Allows generating a summary of SQL query execution details for database operations.

Inheritance

object

DatabaseToolsSqlReport

DatabaseToolsSqlReportOracleDatabase

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatabasetoolsService.Models

Assembly: OCI.DotNetSDK.Databasetools.dll

Syntax

[JsonConverter(typeof(DatabaseToolsSqlReportModelConverter))]
public class DatabaseToolsSqlReport

Properties

Columns

Declaration

[JsonProperty(PropertyName = "columns")]
public List<DatabaseToolsSqlReportColumn> Columns { get; set; }

Property Value

Type	Description
List<DatabaseToolsSqlReportColumn>	Descriptive information on columns referenced in the Database Tools SQL Report source.

CompartmentId

Declaration

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

Property Value

Type	Description
string	The OCID of the compartment containing the Database Tools SQL report.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	A description of the SQL report.

DisplayName

Declaration

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

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the Database Tools SQL report.

Remarks

Required

Instructions

Declaration

[JsonProperty(PropertyName = "instructions")]
public string Instructions { get; set; }

Property Value

Type	Description
string	Instructions on how to use the SQL report. Step-by-step guidance for an AI agent on how to execute or fill in parameters for the report.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message describing the current state in more detail.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseToolsSqlReportLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
DatabaseToolsSqlReportLifecycleState?	The current state of the Database Tools SQL report.

Remarks

Required

Locks

Declaration

[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }

Property Value

Type	Description
List<ResourceLock>	Locks associated with this resource.

Purpose

Declaration

[JsonProperty(PropertyName = "purpose")]
public string Purpose { get; set; }

Property Value

Type	Description
string	Purpose of the Database Tools SQL report. Scenario or conditions describing when or why this report should be used. Provides selection criteria to AI agents to improve report selection accuracy.

Source

Declaration

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

Property Value

Type	Description
string	SQL query executed to generate the report.

Remarks

Required

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time the Database Tools SQL report was created. An RFC3339 formatted datetime string.

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time the Database Tools SQL report was updated. An RFC3339 formatted datetime string.

Remarks

Required

Variables

Declaration

[JsonProperty(PropertyName = "variables")]
public List<DatabaseToolsSqlReportVariable> Variables { get; set; }

Property Value

Type	Description
List<DatabaseToolsSqlReportVariable>	Variables referenced in the Database Tools SQL Report source.