Class Ipv4Header

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

    public final class Ipv4Header
    extends java.lang.Object
    implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.vmware.vapi.data.StructValue __dynamicStructureFields  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        Ipv4Header()
      Default constructor.
      protected Ipv4Header​(com.vmware.vapi.data.StructValue __dynamicStructureFields)  
    • 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 Ipv4Header _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 Ipv4Header _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 getDstIp()
      The destination ip address.
      java.lang.Long getFlags()
      IP flags format: int64
      java.lang.Long getProtocol()
      IP protocol - defaults to ICMP format: int64
      java.lang.String getSrcIp()
      The source ip address.
      java.lang.Long getSrcSubnetPrefixLen()
      This is used together with src_ip to calculate dst_ip for broadcast when dst_ip is not given; not used in all other cases.
      java.lang.Long getTtl()
      Time to live (ttl) format: int64
      int hashCode()  
      void setDstIp​(java.lang.String dstIp)
      The destination ip address.
      void setFlags​(java.lang.Long flags)
      IP flags format: int64
      void setProtocol​(java.lang.Long protocol)
      IP protocol - defaults to ICMP format: int64
      void setSrcIp​(java.lang.String srcIp)
      The source ip address.
      void setSrcSubnetPrefixLen​(java.lang.Long srcSubnetPrefixLen)
      This is used together with src_ip to calculate dst_ip for broadcast when dst_ip is not given; not used in all other cases.
      void setTtl​(java.lang.Long ttl)
      Time to live (ttl) format: int64
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields
    • Constructor Detail

      • Ipv4Header

        public Ipv4Header()
        Default constructor.
      • Ipv4Header

        protected Ipv4Header​(com.vmware.vapi.data.StructValue __dynamicStructureFields)
    • Method Detail

      • getDstIp

        public java.lang.String getDstIp()
        The destination ip address. format: ipv4
        Returns:
        The current value of the property.
      • setDstIp

        public void setDstIp​(java.lang.String dstIp)
        The destination ip address. format: ipv4
        Parameters:
        dstIp - New value for the property.
      • getFlags

        public java.lang.Long getFlags()
        IP flags format: int64
        Returns:
        The current value of the property.
      • setFlags

        public void setFlags​(java.lang.Long flags)
        IP flags format: int64
        Parameters:
        flags - New value for the property.
      • getProtocol

        public java.lang.Long getProtocol()
        IP protocol - defaults to ICMP format: int64
        Returns:
        The current value of the property.
      • setProtocol

        public void setProtocol​(java.lang.Long protocol)
        IP protocol - defaults to ICMP format: int64
        Parameters:
        protocol - New value for the property.
      • getSrcIp

        public java.lang.String getSrcIp()
        The source ip address. format: ipv4
        Returns:
        The current value of the property.
      • setSrcIp

        public void setSrcIp​(java.lang.String srcIp)
        The source ip address. format: ipv4
        Parameters:
        srcIp - New value for the property.
      • getSrcSubnetPrefixLen

        public java.lang.Long getSrcSubnetPrefixLen()
        This is used together with src_ip to calculate dst_ip for broadcast when dst_ip is not given; not used in all other cases. format: int64
        Returns:
        The current value of the property.
      • setSrcSubnetPrefixLen

        public void setSrcSubnetPrefixLen​(java.lang.Long srcSubnetPrefixLen)
        This is used together with src_ip to calculate dst_ip for broadcast when dst_ip is not given; not used in all other cases. format: int64
        Parameters:
        srcSubnetPrefixLen - New value for the property.
      • getTtl

        public java.lang.Long getTtl()
        Time to live (ttl) format: int64
        Returns:
        The current value of the property.
      • setTtl

        public void setTtl​(java.lang.Long ttl)
        Time to live (ttl) format: int64
        Parameters:
        ttl - 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 Ipv4Header _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 Ipv4Header _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.