StreamAction¶

class oci.log_analytics.models.StreamAction(**kwargs)¶

Bases: oci.log_analytics.models.action.Action

Stream action for scheduled task.

Attributes

`TYPE_PURGE`	str(object=’’) -> str
`TYPE_STREAM`	str(object=’’) -> str
`metric_extraction`	Gets the metric_extraction of this StreamAction.
`saved_search_duration`	Gets the saved_search_duration of this StreamAction.
`saved_search_id`	Gets the saved_search_id of this StreamAction.
`template_details`	Gets the template_details of this StreamAction.
`type`	[Required] Gets the type of this Action.

Methods

`__init__`(**kwargs)	Initializes a new StreamAction 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_PURGE = 'PURGE'¶

TYPE_STREAM = 'STREAM'¶

__init__(**kwargs)¶

Initializes a new StreamAction object with values from keyword arguments. The default value of the type attribute of this class is STREAM and it should not be changed. 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 StreamAction. Allowed values for this property are: “STREAM”, “PURGE”
saved_search_id (str) – The value to assign to the saved_search_id property of this StreamAction.
template_details (oci.log_analytics.models.TemplateDetails) – The value to assign to the template_details property of this StreamAction.
metric_extraction (oci.log_analytics.models.MetricExtraction) – The value to assign to the metric_extraction property of this StreamAction.
saved_search_duration (str) – The value to assign to the saved_search_duration property of this StreamAction.

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.

metric_extraction¶

Gets the metric_extraction of this StreamAction.

Returns:	The metric_extraction of this StreamAction.
Return type:	oci.log_analytics.models.MetricExtraction

saved_search_duration¶

Gets the saved_search_duration of this StreamAction. The duration of data to be searched for SAVED_SEARCH tasks, used when the task fires to calculate the query time range.

Duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The value should be positive. The largest supported unit (as opposed to value) is D, e.g. P14D (not P2W).

There are restrictions on the maximum duration value relative to the task schedule value as specified in the following table.

Schedule Interval Range | Maximum Duration

———————————– | —————–: 5 Minutes to 30 Minutes | 1 hour “PT60M”

31 Minutes to 1 Hour | 12 hours “PT720M” 1 Hour+1Minute to 1 Day | 1 day “P1D” 1 Day+1Minute to 1 Week-1Minute | 7 days “P7D” 1 Week to 2 Weeks | 14 days “P14D” greater than 2 Weeks | 30 days “P30D”

If not specified, the duration will be based on the schedule. For example, if the schedule is every 5 minutes then the savedSearchDuration will be “PT5M”; if the schedule is every 3 weeks then the savedSearchDuration will be “P21D”.

Returns:	The saved_search_duration of this StreamAction.
Return type:	str

saved_search_id¶

Gets the saved_search_id of this StreamAction. The ManagementSavedSearch id [OCID] utilized in the action.

Returns:	The saved_search_id of this StreamAction.
Return type:	str

template_details¶

Gets the template_details of this StreamAction.

Returns:	The template_details of this StreamAction.
Return type:	oci.log_analytics.models.TemplateDetails

type¶

[Required] Gets the type of this Action. Action type discriminator.

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

Returns:	The type of this Action.
Return type:	str