CreateDatabaseToolsSqlReportDetails

class oci.database_tools.models.CreateDatabaseToolsSqlReportDetails(**kwargs)

Bases: object

Details for the new Database Tools SQL report.

Attributes:

TYPE_ORACLE_DATABASE	A constant which can be used with the type property of a CreateDatabaseToolsSqlReportDetails.
columns	Gets the columns of this CreateDatabaseToolsSqlReportDetails.
compartment_id	[Required] Gets the compartment_id of this CreateDatabaseToolsSqlReportDetails.
defined_tags	Gets the defined_tags of this CreateDatabaseToolsSqlReportDetails.
description	Gets the description of this CreateDatabaseToolsSqlReportDetails.
display_name	[Required] Gets the display_name of this CreateDatabaseToolsSqlReportDetails.
freeform_tags	Gets the freeform_tags of this CreateDatabaseToolsSqlReportDetails.
instructions	Gets the instructions of this CreateDatabaseToolsSqlReportDetails.
locks	Gets the locks of this CreateDatabaseToolsSqlReportDetails.
purpose	Gets the purpose of this CreateDatabaseToolsSqlReportDetails.
source	[Required] Gets the source of this CreateDatabaseToolsSqlReportDetails.
type	[Required] Gets the type of this CreateDatabaseToolsSqlReportDetails.
variables	Gets the variables of this CreateDatabaseToolsSqlReportDetails.

Methods:

__init__(**kwargs)	Initializes a new CreateDatabaseToolsSqlReportDetails object with values from keyword arguments.
get_subtype(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

TYPE_ORACLE_DATABASE = 'ORACLE_DATABASE'

A constant which can be used with the type property of a CreateDatabaseToolsSqlReportDetails. This constant has a value of “ORACLE_DATABASE”

__init__(**kwargs)

Initializes a new CreateDatabaseToolsSqlReportDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• CreateDatabaseToolsSqlReportOracleDatabaseDetails

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

• type (str) – The value to assign to the type property of this CreateDatabaseToolsSqlReportDetails. Allowed values for this property are: “ORACLE_DATABASE”

• compartment_id (str) – The value to assign to the compartment_id property of this CreateDatabaseToolsSqlReportDetails.

• display_name (str) – The value to assign to the display_name property of this CreateDatabaseToolsSqlReportDetails.

• source (str) – The value to assign to the source property of this CreateDatabaseToolsSqlReportDetails.

• description (str) – The value to assign to the description property of this CreateDatabaseToolsSqlReportDetails.

• purpose (str) – The value to assign to the purpose property of this CreateDatabaseToolsSqlReportDetails.

• instructions (str) – The value to assign to the instructions property of this CreateDatabaseToolsSqlReportDetails.

• variables (list[oci.database_tools.models.DatabaseToolsSqlReportVariable]) – The value to assign to the variables property of this CreateDatabaseToolsSqlReportDetails.

• columns (list[oci.database_tools.models.DatabaseToolsSqlReportColumn]) – The value to assign to the columns property of this CreateDatabaseToolsSqlReportDetails.

• defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDatabaseToolsSqlReportDetails.

• freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDatabaseToolsSqlReportDetails.

• locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this CreateDatabaseToolsSqlReportDetails.

property columns

Gets the columns of this CreateDatabaseToolsSqlReportDetails. Descriptive information on columns referenced in the Database Tools SQL Report source.

Returns

The columns of this CreateDatabaseToolsSqlReportDetails.

Return type

list[oci.database_tools.models.DatabaseToolsSqlReportColumn]

property compartment_id

[Required] Gets the compartment_id of this CreateDatabaseToolsSqlReportDetails. The OCID of the compartment containing the Database Tools SQL report.

Returns

The compartment_id of this CreateDatabaseToolsSqlReportDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateDatabaseToolsSqlReportDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this CreateDatabaseToolsSqlReportDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateDatabaseToolsSqlReportDetails. A description of the SQL report.

Returns

The description of this CreateDatabaseToolsSqlReportDetails.

Return type

str

property display_name

[Required] Gets the display_name of this CreateDatabaseToolsSqlReportDetails. A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.

Returns

The display_name of this CreateDatabaseToolsSqlReportDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateDatabaseToolsSqlReportDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this CreateDatabaseToolsSqlReportDetails.

Return type

dict(str, str)

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property instructions

Gets the instructions of this CreateDatabaseToolsSqlReportDetails. 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.

Returns

The instructions of this CreateDatabaseToolsSqlReportDetails.

Return type

str

property locks

Gets the locks of this CreateDatabaseToolsSqlReportDetails. Locks associated with this resource.

Returns

The locks of this CreateDatabaseToolsSqlReportDetails.

Return type

list[oci.database_tools.models.ResourceLock]

property purpose

Gets the purpose of this CreateDatabaseToolsSqlReportDetails. 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.

Returns

The purpose of this CreateDatabaseToolsSqlReportDetails.

Return type

str

property source

[Required] Gets the source of this CreateDatabaseToolsSqlReportDetails. SQL query executed to generate the report.

Returns

The source of this CreateDatabaseToolsSqlReportDetails.

Return type

str

property type

[Required] Gets the type of this CreateDatabaseToolsSqlReportDetails. The Database Tools SQL report type.

Allowed values for this property are: “ORACLE_DATABASE”

Returns

The type of this CreateDatabaseToolsSqlReportDetails.

Return type

str

property variables

Gets the variables of this CreateDatabaseToolsSqlReportDetails. Variables referenced in the Database Tools SQL Report source.

Returns

The variables of this CreateDatabaseToolsSqlReportDetails.

Return type

list[oci.database_tools.models.DatabaseToolsSqlReportVariable]