SavedQuery¶

class oci.cloud_guard.models.SavedQuery(**kwargs)¶

Bases: object

Details of a saved query.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a SavedQuery.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a SavedQuery.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a SavedQuery.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a SavedQuery.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a SavedQuery.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a SavedQuery.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a SavedQuery.
`compartment_id`	[Required] Gets the compartment_id of this SavedQuery.
`defined_tags`	Gets the defined_tags of this SavedQuery.
`description`	Gets the description of this SavedQuery.
`display_name`	[Required] Gets the display_name of this SavedQuery.
`freeform_tags`	Gets the freeform_tags of this SavedQuery.
`id`	[Required] Gets the id of this SavedQuery.
`lifecycle_state`	Gets the lifecycle_state of this SavedQuery.
`query`	[Required] Gets the query of this SavedQuery.
`system_tags`	Gets the system_tags of this SavedQuery.
`time_created`	Gets the time_created of this SavedQuery.
`time_updated`	Gets the time_updated of this SavedQuery.

Methods

__init__(**kwargs) Initializes a new SavedQuery object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a SavedQuery. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a SavedQuery. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a SavedQuery. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a SavedQuery. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a SavedQuery. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a SavedQuery. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a SavedQuery. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new SavedQuery 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 SavedQuery.
description (str) – The value to assign to the description property of this SavedQuery.
display_name (str) – The value to assign to the display_name property of this SavedQuery.
compartment_id (str) – The value to assign to the compartment_id property of this SavedQuery.
query (str) – The value to assign to the query property of this SavedQuery.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SavedQuery. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘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 SavedQuery.
time_updated (datetime) – The value to assign to the time_updated property of this SavedQuery.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SavedQuery.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SavedQuery.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SavedQuery.

compartment_id¶

[Required] Gets the compartment_id of this SavedQuery. Compartment OCID of the saved query

Returns:	The compartment_id of this SavedQuery.
Return type:	str

defined_tags¶

Gets the defined_tags of this SavedQuery. 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 SavedQuery.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this SavedQuery. Description of the saved query

Returns:	The description of this SavedQuery.
Return type:	str

display_name¶

[Required] Gets the display_name of this SavedQuery. Display name of the saved query

Returns:	The display_name of this SavedQuery.
Return type:	str

freeform_tags¶

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

Avoid entering confidential information.

Returns:	The freeform_tags of this SavedQuery.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this SavedQuery. OCID for the saved query

Returns:	The id of this SavedQuery.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this SavedQuery. The current lifecycle state of the resource

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

Returns:	The lifecycle_state of this SavedQuery.
Return type:	str

query¶

[Required] Gets the query of this SavedQuery. The saved query expression

Returns:	The query of this SavedQuery.
Return type:	str

system_tags¶

Gets the system_tags of this SavedQuery. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this SavedQuery.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this SavedQuery. The date and time the saved query was created. Format defined by RFC3339.

Returns:	The time_created of this SavedQuery.
Return type:	datetime

time_updated¶

Gets the time_updated of this SavedQuery. The date and time the saved query was updated. Format defined by RFC3339.

Returns:	The time_updated of this SavedQuery.
Return type:	datetime