DatabaseToolsSqlReportSummaryOracleDatabase

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

Bases: DatabaseToolsSqlReportSummary

Summary of the Database Tools SQL report for an Oracle Database.

Attributes:

LIFECYCLE_STATE_ACTIVE	A constant which can be used with the lifecycle_state property of a DatabaseToolsSqlReportSummary.
LIFECYCLE_STATE_DELETED	A constant which can be used with the lifecycle_state property of a DatabaseToolsSqlReportSummary.
TYPE_ORACLE_DATABASE	A constant which can be used with the type property of a DatabaseToolsSqlReportSummary.
compartment_id	[Required] Gets the compartment_id of this DatabaseToolsSqlReportSummary.
defined_tags	Gets the defined_tags of this DatabaseToolsSqlReportSummary.
description	Gets the description of this DatabaseToolsSqlReportSummary.
display_name	[Required] Gets the display_name of this DatabaseToolsSqlReportSummary.
freeform_tags	Gets the freeform_tags of this DatabaseToolsSqlReportSummary.
id	[Required] Gets the id of this DatabaseToolsSqlReportSummary.
instructions	Gets the instructions of this DatabaseToolsSqlReportSummary.
lifecycle_details	Gets the lifecycle_details of this DatabaseToolsSqlReportSummary.
lifecycle_state	[Required] Gets the lifecycle_state of this DatabaseToolsSqlReportSummary.
locks	Gets the locks of this DatabaseToolsSqlReportSummary.
purpose	Gets the purpose of this DatabaseToolsSqlReportSummary.
system_tags	Gets the system_tags of this DatabaseToolsSqlReportSummary.
time_created	[Required] Gets the time_created of this DatabaseToolsSqlReportSummary.
time_updated	[Required] Gets the time_updated of this DatabaseToolsSqlReportSummary.
type	[Required] Gets the type of this DatabaseToolsSqlReportSummary.

Methods:

__init__(**kwargs)	Initializes a new DatabaseToolsSqlReportSummaryOracleDatabase 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.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a DatabaseToolsSqlReportSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a DatabaseToolsSqlReportSummary. This constant has a value of “DELETED”

TYPE_ORACLE_DATABASE = 'ORACLE_DATABASE'

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

__init__(**kwargs)

Initializes a new DatabaseToolsSqlReportSummaryOracleDatabase object with values from keyword arguments. The default value of the type attribute of this class is ORACLE_DATABASE and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

• id (str) – The value to assign to the id property of this DatabaseToolsSqlReportSummaryOracleDatabase.

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

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

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

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

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

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

• lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsSqlReportSummaryOracleDatabase. Allowed values for this property are: “ACTIVE”, “DELETED”

• lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseToolsSqlReportSummaryOracleDatabase.

• time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsSqlReportSummaryOracleDatabase.

• time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsSqlReportSummaryOracleDatabase.

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

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

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

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

property compartment_id

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

Returns

The compartment_id of this DatabaseToolsSqlReportSummary.

Return type

str

property defined_tags

Gets the defined_tags of this DatabaseToolsSqlReportSummary. 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 DatabaseToolsSqlReportSummary.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this DatabaseToolsSqlReportSummary.

Return type

str

property display_name

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

Returns

The display_name of this DatabaseToolsSqlReportSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this DatabaseToolsSqlReportSummary. 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 DatabaseToolsSqlReportSummary.

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 id

[Required] Gets the id of this DatabaseToolsSqlReportSummary. The OCID of the Database Tools SQL Report.

Returns

The id of this DatabaseToolsSqlReportSummary.

Return type

str

property instructions

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

Return type

str

property lifecycle_details

Gets the lifecycle_details of this DatabaseToolsSqlReportSummary. A message describing the current state of the Database Tools SQL Report.

Returns

The lifecycle_details of this DatabaseToolsSqlReportSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this DatabaseToolsSqlReportSummary. The current state of the Database Tools SQL Report.

Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this DatabaseToolsSqlReportSummary.

Return type

str

property locks

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

Returns

The locks of this DatabaseToolsSqlReportSummary.

Return type

list[oci.database_tools.models.ResourceLock]

property purpose

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

Return type

str

property system_tags

Gets the system_tags of this DatabaseToolsSqlReportSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this DatabaseToolsSqlReportSummary.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this DatabaseToolsSqlReportSummary. The time the Database Tools SQL Report was created. An RFC3339 formatted datetime string.

Returns

The time_created of this DatabaseToolsSqlReportSummary.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this DatabaseToolsSqlReportSummary. The time the Database Tools SQL Report was updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this DatabaseToolsSqlReportSummary.

Return type

datetime

property type

[Required] Gets the type of this DatabaseToolsSqlReportSummary. The Database Tools SQL Report type.

Allowed values for this property are: “ORACLE_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The type of this DatabaseToolsSqlReportSummary.

Return type

str