Package com.oracle.bmc.vnmonitoring.model

Class Vtap

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Vtap
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A virtual test access point (VTAP) provides a way to mirror all traffic from a designated source to a selected target in order to facilitate troubleshooting, security analysis, and data monitoring.

    A VTAP is functionally similar to a test access point (TAP) you might deploy in your on-premises network.

    A *CaptureFilter* contains a set of *captureFilterRuleDetails* governing what traffic a VTAP mirrors.
    Note: Objects should always be created or deserialized using the Vtap.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 Vtap.Builder, which maintain a set of all explicitly set fields called Vtap.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

      • builder

        public static Vtap.Builder builder()
        Create a new builder.

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the Vtap resource.
        Returns:
        the value

      • getVcnId

        public String getVcnId()
        The OCID of the VCN containing the Vtap resource.
        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. Example: {“foo-namespace”: {“bar-key”: “value”}}

        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()
        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 value

      • getId

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

      • getLifecycleState

        public Vtap.LifecycleState getLifecycleState()
        The VTAP’s administrative lifecycle state.
        Returns:
        the value

      • getLifecycleStateDetails

        public Vtap.LifecycleStateDetails getLifecycleStateDetails()
        The VTAP’s current running state.
        Returns:
        the value

      • getTimeCreated

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

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

        Returns:
        the value

      • getSourceId

        public String getSourceId()
        The OCID of the source point where packets are captured.
        Returns:
        the value

      • getTargetId

        public String getTargetId()
        The OCID of the destination resource where mirrored packets are sent.
        Returns:
        the value

      • getTargetIp

        public String getTargetIp()
        The IP address of the destination resource where mirrored packets are sent.
        Returns:
        the value

      • getCaptureFilterId

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

      • getEncapsulationProtocol

        public Vtap.EncapsulationProtocol getEncapsulationProtocol()
        Defines an encapsulation header type for the VTAP’s mirrored traffic.
        Returns:
        the value

      • getVxlanNetworkIdentifier

        public Long getVxlanNetworkIdentifier()
        The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
        Returns:
        the value

      • getIsVtapEnabled

        public Boolean getIsVtapEnabled()
        Used to start or stop a Vtap resource.

        TRUE directs the VTAP to start mirroring traffic. * FALSE (Default) directs the VTAP to stop mirroring traffic.

        Returns:
        the value

      • getSourceType

        public Vtap.SourceType getSourceType()
        The source type for the VTAP.
        Returns:
        the value

      • getTrafficMode

        public Vtap.TrafficMode getTrafficMode()
        Used to control the priority of traffic.

        It is an optional field. If it not passed, the value is DEFAULT

        Returns:
        the value

      • getMaxPacketSize

        public Integer getMaxPacketSize()
        The maximum size of the packets to be included in the filter.
        Returns:
        the value

      • getTargetType

        public Vtap.TargetType getTargetType()
        The target type for the VTAP.
        Returns:
        the value

      • getSourcePrivateEndpointIp

        public String getSourcePrivateEndpointIp()
        The IP Address of the source private endpoint.
        Returns:
        the value

      • getSourcePrivateEndpointSubnetId

        public String getSourcePrivateEndpointSubnetId()
        The OCID of the subnet that source private endpoint belongs to.
        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