Class Endpoint

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

    public final class Endpoint
    extends java.lang.Object
    implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    An Endpoint object is part of HostSwitch configuration in TransportNode
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Endpoint.Builder
      Builder class for Endpoint.
    • Field Summary

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

      Constructors 
      Modifier Constructor Description
        Endpoint()
      Default constructor.
      protected Endpoint​(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 Endpoint _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 Endpoint _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 getDefaultGateway()
      Gateway IP format: ip This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      java.lang.String getDeviceName()
      Name of the virtual tunnel endpoint This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      java.lang.String getIp()
      Depending upon the EndpointIpConfig used in HostSwitch, IP could be allocated either from DHCP (default) or from Static IP Pool.
      IPv6EndPoint getIpv6()  
      java.lang.Long getLabel()
      Unique label for this Endpoint format: int32 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      java.lang.String getMac()
      MAC address format: mac-address This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      java.lang.String getSubnetMask()
      Subnet mask format: ip This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      int hashCode()  
      void setDefaultGateway​(java.lang.String defaultGateway)
      Gateway IP format: ip This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      void setDeviceName​(java.lang.String deviceName)
      Name of the virtual tunnel endpoint This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      void setIp​(java.lang.String ip)
      Depending upon the EndpointIpConfig used in HostSwitch, IP could be allocated either from DHCP (default) or from Static IP Pool.
      void setIpv6​(IPv6EndPoint ipv6)  
      void setLabel​(java.lang.Long label)
      Unique label for this Endpoint format: int32 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      void setMac​(java.lang.String mac)
      MAC address format: mac-address This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      void setSubnetMask​(java.lang.String subnetMask)
      Subnet mask format: ip This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      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

      • Endpoint

        public Endpoint()
        Default constructor.
      • Endpoint

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

      • getDefaultGateway

        public java.lang.String getDefaultGateway()
        Gateway IP format: ip 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.
      • setDefaultGateway

        public void setDefaultGateway​(java.lang.String defaultGateway)
        Gateway IP format: ip 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:
        defaultGateway - New value for the property.
      • getDeviceName

        public java.lang.String getDeviceName()
        Name of the virtual tunnel endpoint 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.
      • setDeviceName

        public void setDeviceName​(java.lang.String deviceName)
        Name of the virtual tunnel endpoint 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:
        deviceName - New value for the property.
      • getIp

        public java.lang.String getIp()
        Depending upon the EndpointIpConfig used in HostSwitch, IP could be allocated either from DHCP (default) or from Static IP Pool. format: ip 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.
      • setIp

        public void setIp​(java.lang.String ip)
        Depending upon the EndpointIpConfig used in HostSwitch, IP could be allocated either from DHCP (default) or from Static IP Pool. format: ip 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:
        ip - New value for the property.
      • getIpv6

        public IPv6EndPoint getIpv6()
        Returns:
        The current value of the property.
      • setIpv6

        public void setIpv6​(IPv6EndPoint ipv6)
        Parameters:
        ipv6 - New value for the property.
      • getLabel

        public java.lang.Long getLabel()
        Unique label for this Endpoint format: int32 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.
      • setLabel

        public void setLabel​(java.lang.Long label)
        Unique label for this Endpoint format: int32 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:
        label - New value for the property.
      • getMac

        public java.lang.String getMac()
        MAC address format: mac-address 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.
      • setMac

        public void setMac​(java.lang.String mac)
        MAC address format: mac-address 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:
        mac - New value for the property.
      • getSubnetMask

        public java.lang.String getSubnetMask()
        Subnet mask format: ip 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.
      • setSubnetMask

        public void setSubnetMask​(java.lang.String subnetMask)
        Subnet mask format: ip 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:
        subnetMask - 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 Endpoint _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 Endpoint _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.