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

Interface TunnelLinkAttributes

All Superinterfaces:

org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.Grouping

All Known Subinterfaces:

Link1

@Generated("mdsal-binding-generator")
public interface TunnelLinkAttributes
extends org.opendaylight.yangtools.binding.Grouping

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;
   }
 }
 

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.
@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.

Methods inherited from interface org.opendaylight.yangtools.binding.BindingContract

implementedInterface

Method Details

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