CaptureFilter¶

class oci.core.models.CaptureFilter(**kwargs)¶

Bases: object

A capture filter contains a set of :func:`capture_filter_rule_details` governing what traffic is mirrored for a :class:`Vtap` or captured for a `VCN Flow Log`__. The capture filter is created with no rules defined, and it must have at least one rule to mirror traffic for the VTAP or collect VCN flow logs.

Attributes

`FILTER_TYPE_FLOWLOG`	A constant which can be used with the filter_type property of a CaptureFilter.
`FILTER_TYPE_VTAP`	A constant which can be used with the filter_type property of a CaptureFilter.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a CaptureFilter.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a CaptureFilter.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a CaptureFilter.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a CaptureFilter.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a CaptureFilter.
`compartment_id`	[Required] Gets the compartment_id of this CaptureFilter.
`defined_tags`	Gets the defined_tags of this CaptureFilter.
`display_name`	Gets the display_name of this CaptureFilter.
`filter_type`	Gets the filter_type of this CaptureFilter.
`flow_log_capture_filter_rules`	Gets the flow_log_capture_filter_rules of this CaptureFilter.
`freeform_tags`	Gets the freeform_tags of this CaptureFilter.
`id`	[Required] Gets the id of this CaptureFilter.
`lifecycle_state`	[Required] Gets the lifecycle_state of this CaptureFilter.
`time_created`	Gets the time_created of this CaptureFilter.
`vtap_capture_filter_rules`	Gets the vtap_capture_filter_rules of this CaptureFilter.

Methods

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

FILTER_TYPE_FLOWLOG = 'FLOWLOG'¶: A constant which can be used with the filter_type property of a CaptureFilter. This constant has a value of “FLOWLOG”

FILTER_TYPE_VTAP = 'VTAP'¶: A constant which can be used with the filter_type property of a CaptureFilter. This constant has a value of “VTAP”

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a CaptureFilter. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a CaptureFilter. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a CaptureFilter. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a CaptureFilter. This constant has a value of “TERMINATING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a CaptureFilter. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CaptureFilter.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CaptureFilter.
display_name (str) – The value to assign to the display_name property of this CaptureFilter.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CaptureFilter.
id (str) – The value to assign to the id property of this CaptureFilter.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CaptureFilter. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
filter_type (str) – The value to assign to the filter_type property of this CaptureFilter. Allowed values for this property are: “VTAP”, “FLOWLOG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this CaptureFilter.
vtap_capture_filter_rules (list[oci.core.models.VtapCaptureFilterRuleDetails]) – The value to assign to the vtap_capture_filter_rules property of this CaptureFilter.
flow_log_capture_filter_rules (list[oci.core.models.FlowLogCaptureFilterRuleDetails]) – The value to assign to the flow_log_capture_filter_rules property of this CaptureFilter.

compartment_id¶

[Required] Gets the compartment_id of this CaptureFilter. The `OCID`__ of the compartment containing the capture filter.

Returns:	The compartment_id of this CaptureFilter.
Return type:	str

defined_tags¶

Gets the defined_tags of this CaptureFilter. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this CaptureFilter.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this CaptureFilter. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

filter_type¶

Gets the filter_type of this CaptureFilter. Indicates which service will use this capture filter

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

Returns:	The filter_type of this CaptureFilter.
Return type:	str

flow_log_capture_filter_rules¶

Gets the flow_log_capture_filter_rules of this CaptureFilter. The set of rules governing what traffic the VCN flow log collects.

Returns:	The flow_log_capture_filter_rules of this CaptureFilter.
Return type:	list[oci.core.models.FlowLogCaptureFilterRuleDetails]

freeform_tags¶

Gets the freeform_tags of this CaptureFilter. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this CaptureFilter.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this CaptureFilter. The capture filter’s Oracle ID (`OCID`__).

Returns:	The id of this CaptureFilter.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this CaptureFilter. The capture filter’s current administrative state.

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

Returns:	The lifecycle_state of this CaptureFilter.
Return type:	str

time_created¶

Gets the time_created of this CaptureFilter. The date and time the capture filter was created, in the format defined by `RFC3339`__.

Example: 2021-08-25T21:10:29.600Z

Returns:	The time_created of this CaptureFilter.
Return type:	datetime

vtap_capture_filter_rules¶

Gets the vtap_capture_filter_rules of this CaptureFilter. The set of rules governing what traffic a VTAP mirrors.

Returns:	The vtap_capture_filter_rules of this CaptureFilter.
Return type:	list[oci.core.models.VtapCaptureFilterRuleDetails]