Interface Vteps

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Vteps>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<TransportZone>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<VtepsKey>

    @Generated("mdsal-binding-generator")
    public interface Vteps
    extends org.opendaylight.yangtools.yang.binding.ChildOf<TransportZone>, org.opendaylight.yangtools.yang.binding.Augmentable<Vteps>, org.opendaylight.yangtools.yang.binding.Identifiable<VtepsKey>

    This class represents the following YANG schema fragment defined in module itm

     list vteps {
       key dpn-id;
       leaf dpn-id {
         type uint64;
       }
       leaf ip-address {
         type inet:ip-address;
       }
       leaf option-of-tunnel {
         type boolean;
         default false;
       }
       leaf option-tunnel-tos {
         type string {
           length 1..8;
         }
       }
     }
     
    The schema path to identify an instance is itm/transport-zones/transport-zone/vteps

    To create instances of this class use VtepsBuilder.

    See Also:
    VtepsBuilder, VtepsKey
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      static boolean bindingEquals​(@NonNull Vteps thisObj, java.lang.Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull Vteps obj)
      Default implementation of Object.hashCode() contract for this interface.
      static java.lang.String bindingToString​(@NonNull Vteps obj)
      Default implementation of Object.toString() contract for this interface.
      org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
      Return dpnId, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddress()
      Return ipAddress, or null if it is not present.
      java.lang.Boolean getOptionOfTunnel()
      Return optionOfTunnel, or null if it is not present.
      java.lang.String getOptionTunnelTos()
      Return optionTunnelTos, or null if it is not present.
      default java.lang.Class<Vteps> implementedInterface()  
      default java.lang.Boolean isOptionOfTunnel()
      Deprecated, for removal: This API element is subject to removal in a future version.
      VtepsKey key()  
      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation, augmentations
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • implementedInterface

        default java.lang.Class<Vteps> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • bindingHashCode

        static int bindingHashCode​(@NonNull Vteps obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull Vteps thisObj,
                                     java.lang.Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        java.lang.NullPointerException - if thisObj is null
      • bindingToString

        static java.lang.String bindingToString​(@NonNull Vteps obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null
      • getDpnId

        org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
        Return dpnId, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint64 dpnId, or null if it is not present.
      • getIpAddress

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddress()
        Return ipAddress, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ipAddress, or null if it is not present.
      • getOptionOfTunnel

        java.lang.Boolean getOptionOfTunnel()
        Return optionOfTunnel, or null if it is not present.
             
                 Use flow based tunnels for remote-ip
             
         
        Returns:
        java.lang.Boolean optionOfTunnel, or null if it is not present.
      • isOptionOfTunnel

        @Deprecated(forRemoval=true)
        default java.lang.Boolean isOptionOfTunnel()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getOptionTunnelTos

        java.lang.String getOptionTunnelTos()
        Return optionTunnelTos, or null if it is not present.
             
                 Value of ToS bits to be set on the encapsulating packet. The value of 'inherit'
                 will copy the DSCP value from inner IPv4 or IPv6 packets. When ToS is given as a
                 numberic value, the least significant two bits will be ignored.
             
         
        Returns:
        java.lang.String optionTunnelTos, or null if it is not present.
      • key

        VtepsKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<VtepsKey>