Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.rev130819

Interface TunnelLinkAttributes

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
Link1
@Generated("mdsal-binding-generator") public interface TunnelLinkAttributes extends org.opendaylight.yangtools.yang.binding.DataObject
A topology link which is actually a tunnel has additional attributes.

This class represents the following YANG schema fragment defined in module topology-tunnel 

 grouping tunnel-link-attributes {
   container tunnel-types {
     config false;
   }
   leaf-list paths {
     config false;
     type path-ref;
   }
 }

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Set<PathId>
    getPaths()
    Return paths, or null if it is not present.
    TunnelTypes
    getTunnelTypes()
    Return tunnelTypes, or null if it is not present.
    Class<? extends TunnelLinkAttributes>
    implementedInterface()
     
    @NonNull TunnelTypes
    nonnullTunnelTypes()
    Return tunnelTypes, or an empty instance if it is not present.
    default @NonNull Set<PathId>
    requirePaths()
    Return paths, guaranteed to be non-null.

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      Class<? extends TunnelLinkAttributes> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • getTunnelTypes

      TunnelTypes getTunnelTypes()
      Return tunnelTypes, or null if it is not present. 
           
         A tunnel can have multiple traits, each of which is indicated by a presence
         container under this one. Such containers should not carry any data.
      Returns:
      TunnelTypes tunnelTypes, or null if it is not present.

    • nonnullTunnelTypes

      @NonNull TunnelTypes nonnullTunnelTypes()
      Return tunnelTypes, or an empty instance if it is not present.
      Returns:
      TunnelTypes tunnelTypes, or an empty instance if it is not present.

    • getPaths

      @Nullable Set<PathId> getPaths()
      Return paths, or null if it is not present. 
           
         List of paths associated with this tunnel. The exact relationship between the
         tunnel and these paths is technology-specific.
      Returns:
      Set<PathId> paths, or null if it is not present.

    • requirePaths

      default @NonNull Set<PathId> requirePaths()
      Return paths, guaranteed to be non-null. 
           
         List of paths associated with this tunnel. The exact relationship between the
         tunnel and these paths is technology-specific.
      Returns:
      Set<PathId> paths, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if paths is not present