Action¶

class oci.waf.models.Action(**kwargs)¶

Bases: object

An object that represents action and its options. The action can be terminating, if it stops further execution of rules and modules. And non-terminating, if it does not interrupt execution flow.

Attributes

`TYPE_ALLOW`	A constant which can be used with the type property of a Action.
`TYPE_CHECK`	A constant which can be used with the type property of a Action.
`TYPE_RETURN_HTTP_RESPONSE`	A constant which can be used with the type property of a Action.
`name`	[Required] Gets the name of this Action.
`type`	[Required] Gets the type of this Action.

Methods

`__init__`(**kwargs)	Initializes a new Action 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_ALLOW = 'ALLOW'¶: A constant which can be used with the type property of a Action. This constant has a value of “ALLOW”

TYPE_CHECK = 'CHECK'¶: A constant which can be used with the type property of a Action. This constant has a value of “CHECK”

TYPE_RETURN_HTTP_RESPONSE = 'RETURN_HTTP_RESPONSE'¶: A constant which can be used with the type property of a Action. This constant has a value of “RETURN_HTTP_RESPONSE”

__init__(**kwargs)¶

Initializes a new Action object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 Action. Allowed values for this property are: “CHECK”, “ALLOW”, “RETURN_HTTP_RESPONSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’. name (str) – The value to assign to the name property of this Action.

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.

name¶

[Required] Gets the name of this Action. Action name. Can be used to reference the action.

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

type¶

[Required] Gets the type of this Action. * CHECK is a non-terminating action that does not stop the execution of rules in current module,

just emits a log message documenting result of rule execution.

ALLOW is a non-terminating action which upon matching rule skips all remaining rules in the current module.
RETURN_HTTP_RESPONSE is a terminating action which is executed immediately, returns a defined HTTP response.

Allowed values for this property are: “CHECK”, “ALLOW”, “RETURN_HTTP_RESPONSE”, ‘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