SqlCollection

class oci.data_safe.models.SqlCollection(**kwargs)

Bases: object

The resource represents SQL collection for a specific database user in a target. SqlCollection encapsulates the SQL commands issued in the user’s database sessions, and its execution context.

Attributes:

LIFECYCLE_STATE_COLLECTING

A constant which can be used with the lifecycle_state property of a SqlCollection.

LIFECYCLE_STATE_COMPLETED

A constant which can be used with the lifecycle_state property of a SqlCollection.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a SqlCollection.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a SqlCollection.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a SqlCollection.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a SqlCollection.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a SqlCollection.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a SqlCollection.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a SqlCollection.

SQL_LEVEL_ALL_SQL

A constant which can be used with the sql_level property of a SqlCollection.

SQL_LEVEL_USER_ISSUED_SQL

A constant which can be used with the sql_level property of a SqlCollection.

STATUS_DISABLED

A constant which can be used with the status property of a SqlCollection.

STATUS_ENABLED

A constant which can be used with the status property of a SqlCollection.

compartment_id

[Required] Gets the compartment_id of this SqlCollection.

db_user_name

[Required] Gets the db_user_name of this SqlCollection.

defined_tags

Gets the defined_tags of this SqlCollection.

description

Gets the description of this SqlCollection.

display_name

[Required] Gets the display_name of this SqlCollection.

freeform_tags

Gets the freeform_tags of this SqlCollection.

id

[Required] Gets the id of this SqlCollection.

lifecycle_details

Gets the lifecycle_details of this SqlCollection.

lifecycle_state

[Required] Gets the lifecycle_state of this SqlCollection.

sql_level

Gets the sql_level of this SqlCollection.

status

[Required] Gets the status of this SqlCollection.

system_tags

Gets the system_tags of this SqlCollection.

target_id

[Required] Gets the target_id of this SqlCollection.

time_created

[Required] Gets the time_created of this SqlCollection.

time_last_started

Gets the time_last_started of this SqlCollection.

time_last_stopped

Gets the time_last_stopped of this SqlCollection.

time_updated

Gets the time_updated of this SqlCollection.

Methods:

__init__(**kwargs)

Initializes a new SqlCollection object with values from keyword arguments.

LIFECYCLE_STATE_COLLECTING = 'COLLECTING'

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

LIFECYCLE_STATE_COMPLETED = 'COMPLETED'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SQL_LEVEL_ALL_SQL = 'ALL_SQL'

A constant which can be used with the sql_level property of a SqlCollection. This constant has a value of “ALL_SQL”

SQL_LEVEL_USER_ISSUED_SQL = 'USER_ISSUED_SQL'

A constant which can be used with the sql_level property of a SqlCollection. This constant has a value of “USER_ISSUED_SQL”

STATUS_DISABLED = 'DISABLED'

A constant which can be used with the status property of a SqlCollection. This constant has a value of “DISABLED”

STATUS_ENABLED = 'ENABLED'

A constant which can be used with the status property of a SqlCollection. This constant has a value of “ENABLED”

__init__(**kwargs)

Initializes a new SqlCollection object with values from keyword arguments. 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 SqlCollection.

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

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

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

  • target_id (str) – The value to assign to the target_id property of this SqlCollection.

  • status (str) – The value to assign to the status property of this SqlCollection. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • db_user_name (str) – The value to assign to the db_user_name property of this SqlCollection.

  • time_last_started (datetime) – The value to assign to the time_last_started property of this SqlCollection.

  • time_last_stopped (datetime) – The value to assign to the time_last_stopped property of this SqlCollection.

  • sql_level (str) – The value to assign to the sql_level property of this SqlCollection. Allowed values for this property are: “USER_ISSUED_SQL”, “ALL_SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SqlCollection. Allowed values for this property are: “CREATING”, “UPDATING”, “COLLECTING”, “COMPLETED”, “INACTIVE”, “FAILED”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

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

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

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

property compartment_id

[Required] Gets the compartment_id of this SqlCollection. The OCID of the compartment containing the SQL collection.

Returns

The compartment_id of this SqlCollection.

Return type

str

property db_user_name

[Required] Gets the db_user_name of this SqlCollection. The database user name.

Returns

The db_user_name of this SqlCollection.

Return type

str

property defined_tags

Gets the defined_tags of this SqlCollection. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this SqlCollection.

Return type

dict(str, dict(str, object))

property description

Gets the description of this SqlCollection. The description of the SQL collection.

Returns

The description of this SqlCollection.

Return type

str

property display_name

[Required] Gets the display_name of this SqlCollection. The display name of the SQL collection.

Returns

The display_name of this SqlCollection.

Return type

str

property freeform_tags

Gets the freeform_tags of this SqlCollection. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this SqlCollection.

Return type

dict(str, str)

property id

[Required] Gets the id of this SqlCollection. The OCID of the SQL collection.

Returns

The id of this SqlCollection.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this SqlCollection. Details about the current state of the SQL collection in Data Safe.

Returns

The lifecycle_details of this SqlCollection.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this SqlCollection. The current state of the SQL collection.

Allowed values for this property are: “CREATING”, “UPDATING”, “COLLECTING”, “COMPLETED”, “INACTIVE”, “FAILED”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this SqlCollection.

Return type

str

property sql_level

Gets the sql_level of this SqlCollection. Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.

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

Returns

The sql_level of this SqlCollection.

Return type

str

property status

[Required] Gets the status of this SqlCollection. Specifies if the status of the SqlCollection. Enabled indicates that the collecting is in progress.

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

Returns

The status of this SqlCollection.

Return type

str

property system_tags

Gets the system_tags of this SqlCollection. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this SqlCollection.

Return type

dict(str, dict(str, object))

property target_id

[Required] Gets the target_id of this SqlCollection. The OCID of the target corresponding to the security policy deployment.

Returns

The target_id of this SqlCollection.

Return type

str

property time_created

[Required] Gets the time_created of this SqlCollection. The time that the SQL collection was created, in the format defined by RFC3339.

Returns

The time_created of this SqlCollection.

Return type

datetime

property time_last_started

Gets the time_last_started of this SqlCollection. The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.

Returns

The time_last_started of this SqlCollection.

Return type

datetime

property time_last_stopped

Gets the time_last_stopped of this SqlCollection. The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.

Returns

The time_last_stopped of this SqlCollection.

Return type

datetime

property time_updated

Gets the time_updated of this SqlCollection. The last date and time the SQL collection was updated, in the format defined by RFC3339.

Returns

The time_updated of this SqlCollection.

Return type

datetime