Package com.oracle.bmc.core.model

Class CaptureFilter

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class CaptureFilter
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A capture filter contains a set of captureFilterRuleDetails governing what traffic is mirrored for a 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.
    Note: Objects should always be created or deserialized using the CaptureFilter.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CaptureFilter.Builder, which maintain a set of all explicitly set fields called CaptureFilter.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the capture filter.
        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        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 value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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 value

      • getId

        public String getId()
        The capture filter’s Oracle ID (OCID).
        Returns:
        the value

      • getLifecycleState

        public CaptureFilter.LifecycleState getLifecycleState()
        The capture filter’s current administrative state.
        Returns:
        the value

      • getFilterType

        public CaptureFilter.FilterType getFilterType()
        Indicates which service will use this capture filter
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the capture filter was created, in the format defined by RFC3339.

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

        Returns:
        the value

      • getVtapCaptureFilterRules

        public List<VtapCaptureFilterRuleDetails> getVtapCaptureFilterRules()
        The set of rules governing what traffic a VTAP mirrors.
        Returns:
        the value

      • getFlowLogCaptureFilterRules

        public List<FlowLogCaptureFilterRuleDetails> getFlowLogCaptureFilterRules()
        The set of rules governing what traffic the VCN flow log collects.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel