Package com.vmware.nsx_policy.model

Class PolicyIdsEventFlowData

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class PolicyIdsEventFlowData
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    IDS event flow data specific to each IDS event. The data includes source ip, source port, destination ip, destination port, protocol, rule id, profile id, and the action.
    See Also:
    Serialized Form

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T extends com.vmware.vapi.bindings.Structure>
      T      		 _convertTo​(java.lang.Class<T> clazz)  
      java.lang.String _getCanonicalName()  
      static java.lang.String _getCanonicalTypeName()
      Returns the canonical type name.
      static com.vmware.vapi.bindings.type.StructType _getClassType()
      WARNING: Internal method, subject to change in future versions.
      com.vmware.vapi.data.StructValue _getDataValue()  
      com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)  
      java.util.Set<java.lang.String> _getDynamicFieldNames()  
      com.vmware.vapi.bindings.type.StructType _getType()  
      boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)  
      static PolicyIdsEventFlowData _newInstance​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Returns new instance of this binding class and injects the provided data value.
      WARNING: The returned object is not fully initialized.
      static PolicyIdsEventFlowData _newInstance2​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Serves as a versioning mechanism.
      void _setDynamicField​(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)  
      protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)  
      void _validate()  
      boolean equals​(java.lang.Object obj)  
      java.lang.String getActionType()
      Possible values are: ACTION_TYPE_ALERT ACTION_TYPE_DROP ACTION_TYPE_REJECT ACTION_TYPE_INVALID The action pertaining to the detected intrusion.
      java.lang.Long getBytesToclient()
      Bytes sent to client.
      java.lang.Long getBytesToserver()
      Bytes sent to server.
      java.lang.String getClientIp()
      IP address of the VM that initiated the communication.
      java.lang.String getDestinationIp()
      IP address of the destination VM on the intrusion flow.
      java.lang.Long getDestinationPort()
      Port on the destination VM where the traffic was sent to.
      java.lang.String getGateway()
      Name of the gateway on which this intrusion was detected.
      java.util.List<Tag> getGatewayTags()
      Tags associated with the gateway on which this intrusion was detected.
      java.lang.String getHost()
      Name of the host on which this intrusion was detected.
      java.lang.String getLocalVmIp()
      IP address of VM on the host where IDS engine is running.
      java.lang.String getProfileId()
      The IDS profile id that is associated with the IDS rule pertaining to the intrusion event detected.
      java.lang.String getProtocol()
      Traffic protocol pertaining to the detected intrusion, could be TCP/UDP etc.
      java.lang.Long getRuleId()
      The IDS Rule id pertaining to the detected intrusion.
      java.lang.String getSourceIp()
      IP address of the source VM on the intrusion flow.
      java.lang.Long getSourcePort()
      Source port through which traffic was initiated that caused the intrusion to be detected.
      java.lang.String getTrafficType()
      Possible values are: TRAFFIC_TYPE_GATEWAY TRAFFIC_TYPE_HOST The source where the intrusion was detected.
      int hashCode()  
      void setActionType​(java.lang.String actionType)
      Possible values are: ACTION_TYPE_ALERT ACTION_TYPE_DROP ACTION_TYPE_REJECT ACTION_TYPE_INVALID The action pertaining to the detected intrusion.
      void setBytesToclient​(java.lang.Long bytesToclient)
      Bytes sent to client.
      void setBytesToserver​(java.lang.Long bytesToserver)
      Bytes sent to server.
      void setClientIp​(java.lang.String clientIp)
      IP address of the VM that initiated the communication.
      void setDestinationIp​(java.lang.String destinationIp)
      IP address of the destination VM on the intrusion flow.
      void setDestinationPort​(java.lang.Long destinationPort)
      Port on the destination VM where the traffic was sent to.
      void setGateway​(java.lang.String gateway)
      Name of the gateway on which this intrusion was detected.
      void setGatewayTags​(java.util.List<Tag> gatewayTags)
      Tags associated with the gateway on which this intrusion was detected.
      void setHost​(java.lang.String host)
      Name of the host on which this intrusion was detected.
      void setLocalVmIp​(java.lang.String localVmIp)
      IP address of VM on the host where IDS engine is running.
      void setProfileId​(java.lang.String profileId)
      The IDS profile id that is associated with the IDS rule pertaining to the intrusion event detected.
      void setProtocol​(java.lang.String protocol)
      Traffic protocol pertaining to the detected intrusion, could be TCP/UDP etc.
      void setRuleId​(java.lang.Long ruleId)
      The IDS Rule id pertaining to the detected intrusion.
      void setSourceIp​(java.lang.String sourceIp)
      IP address of the source VM on the intrusion flow.
      void setSourcePort​(java.lang.Long sourcePort)
      Source port through which traffic was initiated that caused the intrusion to be detected.
      void setTrafficType​(java.lang.String trafficType)
      Possible values are: TRAFFIC_TYPE_GATEWAY TRAFFIC_TYPE_HOST The source where the intrusion was detected.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • ACTION_TYPE_ALERT

        public static final java.lang.String ACTION_TYPE_ALERT
        See Also:
        Constant Field Values

      • ACTION_TYPE_DROP

        public static final java.lang.String ACTION_TYPE_DROP
        See Also:
        Constant Field Values

      • ACTION_TYPE_REJECT

        public static final java.lang.String ACTION_TYPE_REJECT
        See Also:
        Constant Field Values

      • ACTION_TYPE_INVALID

        public static final java.lang.String ACTION_TYPE_INVALID
        See Also:
        Constant Field Values

      • TRAFFIC_TYPE_GATEWAY

        public static final java.lang.String TRAFFIC_TYPE_GATEWAY
        See Also:
        Constant Field Values

      • TRAFFIC_TYPE_HOST

        public static final java.lang.String TRAFFIC_TYPE_HOST
        See Also:
        Constant Field Values

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • PolicyIdsEventFlowData

        public PolicyIdsEventFlowData()
        Default constructor.

      • PolicyIdsEventFlowData

        protected PolicyIdsEventFlowData​(com.vmware.vapi.data.StructValue __dynamicStructureFields)

    • Method Detail

      • getActionType

        public java.lang.String getActionType()
        Possible values are: The action pertaining to the detected intrusion. Possible values are ALERT, DROP, REJECT, and INVALID. ALERT - If there is a signature match on the packet, it is allowed to pass but a notification is sent to the user notifying an intrusion was detected. DROP - On a signature match, the packet is silently dropped. An alert is sent to the user that an intrusion was detected. REJECT - On a signature match, the packet is dropped and TCP RST or ICMP error messages (for non-TCP pkts) are sent to the endpoints. An alert is sent to the user that an intrusion was detected. INVALID - If the action doesn't belong to any of the above mentioned categories, it is marked as INVALID. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setActionType

        public void setActionType​(java.lang.String actionType)
        Possible values are: The action pertaining to the detected intrusion. Possible values are ALERT, DROP, REJECT, and INVALID. ALERT - If there is a signature match on the packet, it is allowed to pass but a notification is sent to the user notifying an intrusion was detected. DROP - On a signature match, the packet is silently dropped. An alert is sent to the user that an intrusion was detected. REJECT - On a signature match, the packet is dropped and TCP RST or ICMP error messages (for non-TCP pkts) are sent to the endpoints. An alert is sent to the user that an intrusion was detected. INVALID - If the action doesn't belong to any of the above mentioned categories, it is marked as INVALID. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        actionType - New value for the property.

      • getBytesToclient

        public java.lang.Long getBytesToclient()
        Bytes sent to client. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setBytesToclient

        public void setBytesToclient​(java.lang.Long bytesToclient)
        Bytes sent to client. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        bytesToclient - New value for the property.

      • getBytesToserver

        public java.lang.Long getBytesToserver()
        Bytes sent to server. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setBytesToserver

        public void setBytesToserver​(java.lang.Long bytesToserver)
        Bytes sent to server. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        bytesToserver - New value for the property.

      • getClientIp

        public java.lang.String getClientIp()
        IP address of the VM that initiated the communication. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setClientIp

        public void setClientIp​(java.lang.String clientIp)
        IP address of the VM that initiated the communication. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        clientIp - New value for the property.

      • getDestinationIp

        public java.lang.String getDestinationIp()
        IP address of the destination VM on the intrusion flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setDestinationIp

        public void setDestinationIp​(java.lang.String destinationIp)
        IP address of the destination VM on the intrusion flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        destinationIp - New value for the property.

      • getDestinationPort

        public java.lang.Long getDestinationPort()
        Port on the destination VM where the traffic was sent to. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setDestinationPort

        public void setDestinationPort​(java.lang.Long destinationPort)
        Port on the destination VM where the traffic was sent to. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        destinationPort - New value for the property.

      • getGateway

        public java.lang.String getGateway()
        Name of the gateway on which this intrusion was detected. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setGateway

        public void setGateway​(java.lang.String gateway)
        Name of the gateway on which this intrusion was detected. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        gateway - New value for the property.

      • getGatewayTags

        public java.util.List<Tag> getGatewayTags()
        Tags associated with the gateway on which this intrusion was detected. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setGatewayTags

        public void setGatewayTags​(java.util.List<Tag> gatewayTags)
        Tags associated with the gateway on which this intrusion was detected. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        gatewayTags - New value for the property.

      • getHost

        public java.lang.String getHost()
        Name of the host on which this intrusion was detected. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setHost

        public void setHost​(java.lang.String host)
        Name of the host on which this intrusion was detected. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        host - New value for the property.

      • getLocalVmIp

        public java.lang.String getLocalVmIp()
        IP address of VM on the host where IDS engine is running. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setLocalVmIp

        public void setLocalVmIp​(java.lang.String localVmIp)
        IP address of VM on the host where IDS engine is running. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        localVmIp - New value for the property.

      • getProfileId

        public java.lang.String getProfileId()
        The IDS profile id that is associated with the IDS rule pertaining to the intrusion event detected. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setProfileId

        public void setProfileId​(java.lang.String profileId)
        The IDS profile id that is associated with the IDS rule pertaining to the intrusion event detected. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        profileId - New value for the property.

      • getProtocol

        public java.lang.String getProtocol()
        Traffic protocol pertaining to the detected intrusion, could be TCP/UDP etc. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setProtocol

        public void setProtocol​(java.lang.String protocol)
        Traffic protocol pertaining to the detected intrusion, could be TCP/UDP etc. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        protocol - New value for the property.

      • getRuleId

        public java.lang.Long getRuleId()
        The IDS Rule id pertaining to the detected intrusion. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setRuleId

        public void setRuleId​(java.lang.Long ruleId)
        The IDS Rule id pertaining to the detected intrusion. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        ruleId - New value for the property.

      • getSourceIp

        public java.lang.String getSourceIp()
        IP address of the source VM on the intrusion flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setSourceIp

        public void setSourceIp​(java.lang.String sourceIp)
        IP address of the source VM on the intrusion flow. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        sourceIp - New value for the property.

      • getSourcePort

        public java.lang.Long getSourcePort()
        Source port through which traffic was initiated that caused the intrusion to be detected. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setSourcePort

        public void setSourcePort​(java.lang.Long sourcePort)
        Source port through which traffic was initiated that caused the intrusion to be detected. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        sourcePort - New value for the property.

      • getTrafficType

        public java.lang.String getTrafficType()
        Possible values are: The source where the intrusion was detected. Possible values are GATEWAY and HOST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setTrafficType

        public void setTrafficType​(java.lang.String trafficType)
        Possible values are: The source where the intrusion was detected. Possible values are GATEWAY and HOST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        trafficType - New value for the property.

      • _getType

        public com.vmware.vapi.bindings.type.StructType _getType()
        Specified by:
        _getType in interface com.vmware.vapi.bindings.StaticStructure

      • _getDataValue

        public com.vmware.vapi.data.StructValue _getDataValue()
        Specified by:
        _getDataValue in interface com.vmware.vapi.bindings.Structure

      • _updateDataValue

        protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)

      • _validate

        public void _validate()
        Specified by:
        _validate in interface com.vmware.vapi.bindings.StaticStructure

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface com.vmware.vapi.bindings.StaticStructure
        Overrides:
        toString in class java.lang.Object

      • _hasTypeNameOf

        public boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
        Specified by:
        _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

      • _convertTo

        public <T extends com.vmware.vapi.bindings.Structure> T _convertTo​(java.lang.Class<T> clazz)
        Specified by:
        _convertTo in interface com.vmware.vapi.bindings.Structure

      • _setDynamicField

        public void _setDynamicField​(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
        Specified by:
        _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicField

        public com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)
        Specified by:
        _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicFieldNames

        public java.util.Set<java.lang.String> _getDynamicFieldNames()
        Specified by:
        _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

      • _getClassType

        public static com.vmware.vapi.bindings.type.StructType _getClassType()
        WARNING: Internal method, subject to change in future versions.
        Returns:
        StructType instance representing the static bindings type for this Structure.

      • _getCanonicalName

        public java.lang.String _getCanonicalName()
        Specified by:
        _getCanonicalName in interface com.vmware.vapi.bindings.Structure

      • _getCanonicalTypeName

        public static java.lang.String _getCanonicalTypeName()
        Returns the canonical type name. See _getCanonicalName().
        Returns:
        canonical type name

      • _newInstance

        public static PolicyIdsEventFlowData _newInstance​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Returns new instance of this binding class and injects the provided data value.
        WARNING: The returned object is not fully initialized.
        Parameters:
        structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
        Returns:
        the static bindings StructType

      • _newInstance2

        public static PolicyIdsEventFlowData _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.