WebAppFirewallSummary

class oci.waf.models.WebAppFirewallSummary(**kwargs)

Bases: object

Summary of the WebAppFirewall.

Attributes

BACKEND_TYPE_LOAD_BALANCER A constant which can be used with the backend_type property of a WebAppFirewallSummary.
backend_type [Required] Gets the backend_type of this WebAppFirewallSummary.
compartment_id [Required] Gets the compartment_id of this WebAppFirewallSummary.
defined_tags [Required] Gets the defined_tags of this WebAppFirewallSummary.
display_name [Required] Gets the display_name of this WebAppFirewallSummary.
freeform_tags [Required] Gets the freeform_tags of this WebAppFirewallSummary.
id [Required] Gets the id of this WebAppFirewallSummary.
lifecycle_details Gets the lifecycle_details of this WebAppFirewallSummary.
lifecycle_state [Required] Gets the lifecycle_state of this WebAppFirewallSummary.
system_tags [Required] Gets the system_tags of this WebAppFirewallSummary.
time_created [Required] Gets the time_created of this WebAppFirewallSummary.
time_updated Gets the time_updated of this WebAppFirewallSummary.
web_app_firewall_policy_id [Required] Gets the web_app_firewall_policy_id of this WebAppFirewallSummary.

Methods

__init__(**kwargs) Initializes a new WebAppFirewallSummary 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.
BACKEND_TYPE_LOAD_BALANCER = 'LOAD_BALANCER'

A constant which can be used with the backend_type property of a WebAppFirewallSummary. This constant has a value of “LOAD_BALANCER”

__init__(**kwargs)

Initializes a new WebAppFirewallSummary 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:
  • id (str) – The value to assign to the id property of this WebAppFirewallSummary.
  • display_name (str) – The value to assign to the display_name property of this WebAppFirewallSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this WebAppFirewallSummary.
  • backend_type (str) – The value to assign to the backend_type property of this WebAppFirewallSummary. Allowed values for this property are: “LOAD_BALANCER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • web_app_firewall_policy_id (str) – The value to assign to the web_app_firewall_policy_id property of this WebAppFirewallSummary.
  • time_created (datetime) – The value to assign to the time_created property of this WebAppFirewallSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this WebAppFirewallSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this WebAppFirewallSummary.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this WebAppFirewallSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this WebAppFirewallSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this WebAppFirewallSummary.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this WebAppFirewallSummary.
backend_type

[Required] Gets the backend_type of this WebAppFirewallSummary. Type of the WebAppFirewall, as example LOAD_BALANCER.

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

Returns:The backend_type of this WebAppFirewallSummary.
Return type:str
compartment_id

[Required] Gets the compartment_id of this WebAppFirewallSummary. The OCID of the compartment.

Returns:The compartment_id of this WebAppFirewallSummary.
Return type:str
defined_tags

[Required] Gets the defined_tags of this WebAppFirewallSummary. 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 WebAppFirewallSummary.
Return type:dict(str, dict(str, object))
display_name

[Required] Gets the display_name of this WebAppFirewallSummary. WebAppFirewall display name, can be renamed.

Returns:The display_name of this WebAppFirewallSummary.
Return type:str
freeform_tags

[Required] Gets the freeform_tags of this WebAppFirewallSummary. 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 WebAppFirewallSummary.
Return type:dict(str, 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.

id

[Required] Gets the id of this WebAppFirewallSummary. The OCID of the WebAppFirewall.

Returns:The id of this WebAppFirewallSummary.
Return type:str
lifecycle_details

Gets the lifecycle_details of this WebAppFirewallSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.

Returns:The lifecycle_details of this WebAppFirewallSummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this WebAppFirewallSummary. The current state of the WebAppFirewall.

Returns:The lifecycle_state of this WebAppFirewallSummary.
Return type:str
system_tags

[Required] Gets the system_tags of this WebAppFirewallSummary. 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 WebAppFirewallSummary.
Return type:dict(str, dict(str, object))
time_created

[Required] Gets the time_created of this WebAppFirewallSummary. The time the WebAppFirewall was created. An RFC3339 formatted datetime string.

Returns:The time_created of this WebAppFirewallSummary.
Return type:datetime
time_updated

Gets the time_updated of this WebAppFirewallSummary. The time the WebAppFirewall was updated. An RFC3339 formatted datetime string.

Returns:The time_updated of this WebAppFirewallSummary.
Return type:datetime
web_app_firewall_policy_id

[Required] Gets the web_app_firewall_policy_id of this WebAppFirewallSummary. The OCID of WebAppFirewallPolicy, which is attached to the resource.

Returns:The web_app_firewall_policy_id of this WebAppFirewallSummary.
Return type:str