PurgeAction¶

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

Bases: oci.log_analytics.models.action.Action

Purge action for scheduled task.

Attributes

`DATA_TYPE_LOG`	A constant which can be used with the data_type property of a PurgeAction.
`DATA_TYPE_LOOKUP`	A constant which can be used with the data_type property of a PurgeAction.
`TYPE_PURGE`	str(object=’’) -> str
`TYPE_STREAM`	str(object=’’) -> str
`compartment_id_in_subtree`	Gets the compartment_id_in_subtree of this PurgeAction.
`data_type`	[Required] Gets the data_type of this PurgeAction.
`purge_compartment_id`	[Required] Gets the purge_compartment_id of this PurgeAction.
`purge_duration`	[Required] Gets the purge_duration of this PurgeAction.
`query_string`	[Required] Gets the query_string of this PurgeAction.
`type`	[Required] Gets the type of this Action.

Methods

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

DATA_TYPE_LOG = 'LOG'¶: A constant which can be used with the data_type property of a PurgeAction. This constant has a value of “LOG”

DATA_TYPE_LOOKUP = 'LOOKUP'¶: A constant which can be used with the data_type property of a PurgeAction. This constant has a value of “LOOKUP”

TYPE_PURGE = 'PURGE'¶

TYPE_STREAM = 'STREAM'¶

__init__(**kwargs)¶

Initializes a new PurgeAction object with values from keyword arguments. The default value of the type attribute of this class is PURGE 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 PurgeAction. 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’.
query_string (str) – The value to assign to the query_string property of this PurgeAction.
data_type (str) – The value to assign to the data_type property of this PurgeAction. Allowed values for this property are: “LOG”, “LOOKUP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
purge_duration (str) – The value to assign to the purge_duration property of this PurgeAction.
purge_compartment_id (str) – The value to assign to the purge_compartment_id property of this PurgeAction.
compartment_id_in_subtree (bool) – The value to assign to the compartment_id_in_subtree property of this PurgeAction.

compartment_id_in_subtree¶

Gets the compartment_id_in_subtree of this PurgeAction. if true, purge child compartments data

Returns:	The compartment_id_in_subtree of this PurgeAction.
Return type:	bool

data_type¶

[Required] Gets the data_type of this PurgeAction. the type of the log data to be purged

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

Returns:	The data_type of this PurgeAction.
Return type:	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.

purge_compartment_id¶

[Required] Gets the purge_compartment_id of this PurgeAction. the compartment OCID under which the data will be purged

Returns:	The purge_compartment_id of this PurgeAction.
Return type:	str

purge_duration¶

[Required] Gets the purge_duration of this PurgeAction. The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W).

Returns:	The purge_duration of this PurgeAction.
Return type:	str

query_string¶

[Required] Gets the query_string of this PurgeAction. Purge query string.

Returns:	The query_string of this PurgeAction.
Return type:	str

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