ProtectionCapabilitySummary¶

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

Bases: object

A summary of available OCI-managed protection capabilities in WebAppFirewallPolicy. Protection capabilies checks HTTP requests/responses if they are malicious.

Attributes

`TYPE_REQUEST_PROTECTION_CAPABILITY`	A constant which can be used with the type property of a ProtectionCapabilitySummary.
`TYPE_RESPONSE_PROTECTION_CAPABILITY`	A constant which can be used with the type property of a ProtectionCapabilitySummary.
`collaborative_action_threshold`	Gets the collaborative_action_threshold of this ProtectionCapabilitySummary.
`collaborative_weights`	Gets the collaborative_weights of this ProtectionCapabilitySummary.
`description`	[Required] Gets the description of this ProtectionCapabilitySummary.
`display_name`	[Required] Gets the display_name of this ProtectionCapabilitySummary.
`group_tags`	Gets the group_tags of this ProtectionCapabilitySummary.
`is_latest_version`	[Required] Gets the is_latest_version of this ProtectionCapabilitySummary.
`key`	[Required] Gets the key of this ProtectionCapabilitySummary.
`type`	[Required] Gets the type of this ProtectionCapabilitySummary.
`version`	[Required] Gets the version of this ProtectionCapabilitySummary.

Methods

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

TYPE_REQUEST_PROTECTION_CAPABILITY = 'REQUEST_PROTECTION_CAPABILITY'¶: A constant which can be used with the type property of a ProtectionCapabilitySummary. This constant has a value of “REQUEST_PROTECTION_CAPABILITY”

TYPE_RESPONSE_PROTECTION_CAPABILITY = 'RESPONSE_PROTECTION_CAPABILITY'¶: A constant which can be used with the type property of a ProtectionCapabilitySummary. This constant has a value of “RESPONSE_PROTECTION_CAPABILITY”

__init__(**kwargs)¶

Initializes a new ProtectionCapabilitySummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

key (str) – The value to assign to the key property of this ProtectionCapabilitySummary.
display_name (str) – The value to assign to the display_name property of this ProtectionCapabilitySummary.
description (str) – The value to assign to the description property of this ProtectionCapabilitySummary.
version (int) – The value to assign to the version property of this ProtectionCapabilitySummary.
is_latest_version (bool) – The value to assign to the is_latest_version property of this ProtectionCapabilitySummary.
group_tags (list[str]) – The value to assign to the group_tags property of this ProtectionCapabilitySummary.
type (str) – The value to assign to the type property of this ProtectionCapabilitySummary. Allowed values for this property are: “REQUEST_PROTECTION_CAPABILITY”, “RESPONSE_PROTECTION_CAPABILITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
collaborative_action_threshold (int) – The value to assign to the collaborative_action_threshold property of this ProtectionCapabilitySummary.
collaborative_weights (list[oci.waf.models.CollaborativeCapabilityWeight]) – The value to assign to the collaborative_weights property of this ProtectionCapabilitySummary.

collaborative_action_threshold¶

Gets the collaborative_action_threshold of this ProtectionCapabilitySummary. The default collaborative action threshold for OCI-managed collaborative protection capability. Collaborative protection capabilities are made of several simple, non-collaborative protection capabilities (referred to as contributing capabilities later on) which have weights assigned to them. These weights can be found in the collaborativeWeights array. For incoming/outgoing HTTP messages, all contributing capabilities are executed and the sum of all triggered contributing capabilities weights is calculated. Only if this sum is greater than or equal to collaborativeActionThreshold is the incoming/outgoing HTTP message marked as malicious.

This field is ignored for non-collaborative capabilities.

Returns:	The collaborative_action_threshold of this ProtectionCapabilitySummary.
Return type:	int

collaborative_weights¶

Gets the collaborative_weights of this ProtectionCapabilitySummary. The weights of contributing capabilities. Defines how much each contributing capability contributes towards the action threshold of a collaborative protection capability.

This field is ignored for non-collaborative capabilities.

Returns:	The collaborative_weights of this ProtectionCapabilitySummary.
Return type:	list[oci.waf.models.CollaborativeCapabilityWeight]

description¶

[Required] Gets the description of this ProtectionCapabilitySummary. The description of protection capability.

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

display_name¶

[Required] Gets the display_name of this ProtectionCapabilitySummary. The display name of protection capability.

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

group_tags¶

Gets the group_tags of this ProtectionCapabilitySummary. The list of unique names protection capability group tags that are associated with this capability. Example: [“PCI”, “Recommended”]

Returns:	The group_tags of this ProtectionCapabilitySummary.
Return type:	list[str]

is_latest_version¶

[Required] Gets the is_latest_version of this ProtectionCapabilitySummary. The field that shows if this is the latest version of protection capability.

Returns:	The is_latest_version of this ProtectionCapabilitySummary.
Return type:	bool

key¶

[Required] Gets the key of this ProtectionCapabilitySummary. Unique key of protection capability.

Returns:	The key of this ProtectionCapabilitySummary.
Return type:	str

type¶

[Required] Gets the type of this ProtectionCapabilitySummary. The type of protection capability.

REQUEST_PROTECTION_CAPABILITY can only be used in requestProtection module of WebAppFirewallPolicy.
RESPONSE_PROTECTION_CAPABILITY can only be used in responseProtection module of WebAppFirewallPolicy.

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

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

version¶

[Required] Gets the version of this ProtectionCapabilitySummary. The version of protection capability.

Returns:	The version of this ProtectionCapabilitySummary.
Return type:	int