ScheduledQuery¶

class oci.apm_traces.models.ScheduledQuery(**kwargs)¶

Bases: object

Scheduled Query object.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ScheduledQuery.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ScheduledQuery.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ScheduledQuery.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ScheduledQuery.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ScheduledQuery.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ScheduledQuery.
`SCHEDULED_QUERY_PROCESSING_SUB_TYPE_CUSTOM_METRIC`	A constant which can be used with the scheduled_query_processing_sub_type property of a ScheduledQuery.
`SCHEDULED_QUERY_PROCESSING_SUB_TYPE_NONE`	A constant which can be used with the scheduled_query_processing_sub_type property of a ScheduledQuery.
`SCHEDULED_QUERY_PROCESSING_SUB_TYPE_OBJECT_STORAGE`	A constant which can be used with the scheduled_query_processing_sub_type property of a ScheduledQuery.
`SCHEDULED_QUERY_PROCESSING_SUB_TYPE_STREAMING`	A constant which can be used with the scheduled_query_processing_sub_type property of a ScheduledQuery.
`SCHEDULED_QUERY_PROCESSING_TYPE_ALERT`	A constant which can be used with the scheduled_query_processing_type property of a ScheduledQuery.
`SCHEDULED_QUERY_PROCESSING_TYPE_EXPORT`	A constant which can be used with the scheduled_query_processing_type property of a ScheduledQuery.
`SCHEDULED_QUERY_PROCESSING_TYPE_QUERY`	A constant which can be used with the scheduled_query_processing_type property of a ScheduledQuery.
`SCHEDULED_QUERY_RETENTION_CRITERIA_KEEP_DATA_UNTIL_RETENTION_PERIOD`	A constant which can be used with the scheduled_query_retention_criteria property of a ScheduledQuery.
`SCHEDULED_QUERY_RETENTION_CRITERIA_UPDATE`	A constant which can be used with the scheduled_query_retention_criteria property of a ScheduledQuery.
`defined_tags`	Gets the defined_tags of this ScheduledQuery.
`freeform_tags`	Gets the freeform_tags of this ScheduledQuery.
`id`	Gets the id of this ScheduledQuery.
`lifecycle_state`	Gets the lifecycle_state of this ScheduledQuery.
`scheduled_query_description`	Gets the scheduled_query_description of this ScheduledQuery.
`scheduled_query_instances`	Gets the scheduled_query_instances of this ScheduledQuery.
`scheduled_query_maximum_runtime_in_seconds`	Gets the scheduled_query_maximum_runtime_in_seconds of this ScheduledQuery.
`scheduled_query_name`	Gets the scheduled_query_name of this ScheduledQuery.
`scheduled_query_next_run_in_ms`	Gets the scheduled_query_next_run_in_ms of this ScheduledQuery.
`scheduled_query_processing_configuration`	Gets the scheduled_query_processing_configuration of this ScheduledQuery.
`scheduled_query_processing_sub_type`	Gets the scheduled_query_processing_sub_type of this ScheduledQuery.
`scheduled_query_processing_type`	Gets the scheduled_query_processing_type of this ScheduledQuery.
`scheduled_query_retention_criteria`	Gets the scheduled_query_retention_criteria of this ScheduledQuery.
`scheduled_query_retention_period_in_ms`	Gets the scheduled_query_retention_period_in_ms of this ScheduledQuery.
`scheduled_query_schedule`	Gets the scheduled_query_schedule of this ScheduledQuery.
`scheduled_query_text`	Gets the scheduled_query_text of this ScheduledQuery.
`system_tags`	Gets the system_tags of this ScheduledQuery.

Methods

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

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

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

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

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

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

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

SCHEDULED_QUERY_PROCESSING_SUB_TYPE_CUSTOM_METRIC = 'CUSTOM_METRIC'¶: A constant which can be used with the scheduled_query_processing_sub_type property of a ScheduledQuery. This constant has a value of “CUSTOM_METRIC”

SCHEDULED_QUERY_PROCESSING_SUB_TYPE_NONE = 'NONE'¶: A constant which can be used with the scheduled_query_processing_sub_type property of a ScheduledQuery. This constant has a value of “NONE”

SCHEDULED_QUERY_PROCESSING_SUB_TYPE_OBJECT_STORAGE = 'OBJECT_STORAGE'¶: A constant which can be used with the scheduled_query_processing_sub_type property of a ScheduledQuery. This constant has a value of “OBJECT_STORAGE”

SCHEDULED_QUERY_PROCESSING_SUB_TYPE_STREAMING = 'STREAMING'¶: A constant which can be used with the scheduled_query_processing_sub_type property of a ScheduledQuery. This constant has a value of “STREAMING”

SCHEDULED_QUERY_PROCESSING_TYPE_ALERT = 'ALERT'¶: A constant which can be used with the scheduled_query_processing_type property of a ScheduledQuery. This constant has a value of “ALERT”

SCHEDULED_QUERY_PROCESSING_TYPE_EXPORT = 'EXPORT'¶: A constant which can be used with the scheduled_query_processing_type property of a ScheduledQuery. This constant has a value of “EXPORT”

SCHEDULED_QUERY_PROCESSING_TYPE_QUERY = 'QUERY'¶: A constant which can be used with the scheduled_query_processing_type property of a ScheduledQuery. This constant has a value of “QUERY”

SCHEDULED_QUERY_RETENTION_CRITERIA_KEEP_DATA_UNTIL_RETENTION_PERIOD = 'KEEP_DATA_UNTIL_RETENTION_PERIOD'¶: A constant which can be used with the scheduled_query_retention_criteria property of a ScheduledQuery. This constant has a value of “KEEP_DATA_UNTIL_RETENTION_PERIOD”

SCHEDULED_QUERY_RETENTION_CRITERIA_UPDATE = 'UPDATE'¶: A constant which can be used with the scheduled_query_retention_criteria property of a ScheduledQuery. This constant has a value of “UPDATE”

__init__(**kwargs)¶

Initializes a new ScheduledQuery 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 ScheduledQuery.
scheduled_query_processing_type (str) – The value to assign to the scheduled_query_processing_type property of this ScheduledQuery. Allowed values for this property are: “EXPORT”, “QUERY”, “ALERT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
scheduled_query_name (str) – The value to assign to the scheduled_query_name property of this ScheduledQuery.
scheduled_query_text (str) – The value to assign to the scheduled_query_text property of this ScheduledQuery.
scheduled_query_description (str) – The value to assign to the scheduled_query_description property of this ScheduledQuery.
scheduled_query_schedule (str) – The value to assign to the scheduled_query_schedule property of this ScheduledQuery.
scheduled_query_maximum_runtime_in_seconds (int) – The value to assign to the scheduled_query_maximum_runtime_in_seconds property of this ScheduledQuery.
scheduled_query_next_run_in_ms (int) – The value to assign to the scheduled_query_next_run_in_ms property of this ScheduledQuery.
scheduled_query_retention_period_in_ms (int) – The value to assign to the scheduled_query_retention_period_in_ms property of this ScheduledQuery.
scheduled_query_processing_sub_type (str) – The value to assign to the scheduled_query_processing_sub_type property of this ScheduledQuery. Allowed values for this property are: “OBJECT_STORAGE”, “STREAMING”, “CUSTOM_METRIC”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
scheduled_query_processing_configuration (oci.apm_traces.models.ScheduledQueryProcessingConfig) – The value to assign to the scheduled_query_processing_configuration property of this ScheduledQuery.
scheduled_query_retention_criteria (str) – The value to assign to the scheduled_query_retention_criteria property of this ScheduledQuery. Allowed values for this property are: “KEEP_DATA_UNTIL_RETENTION_PERIOD”, “UPDATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
scheduled_query_instances (str) – The value to assign to the scheduled_query_instances property of this ScheduledQuery.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ScheduledQuery. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ScheduledQuery.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ScheduledQuery.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ScheduledQuery.

defined_tags¶

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

freeform_tags¶

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

id¶

Gets the id of this ScheduledQuery. The OCID of the scheduled query . An OCID is generated when the scheduled query is created.

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

lifecycle_state¶

Gets the lifecycle_state of this ScheduledQuery. The current lifecycle state of the Scheduled Query.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 ScheduledQuery.
Return type:	str

scheduled_query_description¶

Gets the scheduled_query_description of this ScheduledQuery. Description for the scheduled query.

Returns:	The scheduled_query_description of this ScheduledQuery.
Return type:	str

scheduled_query_instances¶

Gets the scheduled_query_instances of this ScheduledQuery. Scheduled query instances.

Returns:	The scheduled_query_instances of this ScheduledQuery.
Return type:	str

scheduled_query_maximum_runtime_in_seconds¶

Gets the scheduled_query_maximum_runtime_in_seconds of this ScheduledQuery. Maximum runtime for the scheduled query in seconds.

Returns:	The scheduled_query_maximum_runtime_in_seconds of this ScheduledQuery.
Return type:	int

scheduled_query_name¶

Gets the scheduled_query_name of this ScheduledQuery. Name of the scheduled query.

Returns:	The scheduled_query_name of this ScheduledQuery.
Return type:	str

scheduled_query_next_run_in_ms¶

Gets the scheduled_query_next_run_in_ms of this ScheduledQuery. Next run for the scheduled query.

Returns:	The scheduled_query_next_run_in_ms of this ScheduledQuery.
Return type:	int

scheduled_query_processing_configuration¶

Gets the scheduled_query_processing_configuration of this ScheduledQuery.

Returns:	The scheduled_query_processing_configuration of this ScheduledQuery.
Return type:	oci.apm_traces.models.ScheduledQueryProcessingConfig

scheduled_query_processing_sub_type¶

Gets the scheduled_query_processing_sub_type of this ScheduledQuery. Processing sub type of the scheduled query.

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

Returns:	The scheduled_query_processing_sub_type of this ScheduledQuery.
Return type:	str

scheduled_query_processing_type¶

Gets the scheduled_query_processing_type of this ScheduledQuery. Processing type of the scheduled query.

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

Returns:	The scheduled_query_processing_type of this ScheduledQuery.
Return type:	str

scheduled_query_retention_criteria¶

Gets the scheduled_query_retention_criteria of this ScheduledQuery. Retention criteria for the scheduled query.

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

Returns:	The scheduled_query_retention_criteria of this ScheduledQuery.
Return type:	str

scheduled_query_retention_period_in_ms¶

Gets the scheduled_query_retention_period_in_ms of this ScheduledQuery. Retention period for the scheduled query in milliseconds.

Returns:	The scheduled_query_retention_period_in_ms of this ScheduledQuery.
Return type:	int

scheduled_query_schedule¶

Gets the scheduled_query_schedule of this ScheduledQuery. Schedule for the scheduled query.

Returns:	The scheduled_query_schedule of this ScheduledQuery.
Return type:	str

scheduled_query_text¶

Gets the scheduled_query_text of this ScheduledQuery. Scheduled query to be run.

Returns:	The scheduled_query_text of this ScheduledQuery.
Return type:	str

system_tags¶

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