Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021

Interface LinkAttributes

All Superinterfaces:

BindingObject, DataContainer, DataObject

All Known Subinterfaces:

Link

@Generated("mdsal-binding-generator")
public interface LinkAttributes
extends DataObject

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

 grouping link-attributes {
   leaf link-id {
     type link-id;
   }
   container source {
     leaf source-node {
       type node-ref;
     }
     leaf source-tp {
       type tp-ref;
     }
   }
   container destination {
     leaf dest-node {
       type node-ref;
     }
     leaf dest-tp {
       type tp-ref;
     }
   }
   list supporting-link {
     key link-ref;
     leaf link-ref {
       type link-ref;
     }
   }
 }
 

The schema path to identify an instance is network-topology/link-attributes

Field Summary

Fields

Modifier and Type	Field	Description
static @NonNull QName	QNAME

Method Summary

Modifier and Type	Method	Description
Destination	getDestination()	Return destination, or null if it is not present.
LinkId	getLinkId()	Return linkId, or null if it is not present.
Source	getSource()	Return source, or null if it is not present.
@Nullable Map<SupportingLinkKey,SupportingLink>	getSupportingLink()	Return supportingLink, or null if it is not present.
Class<? extends LinkAttributes>	implementedInterface()	Return the interface implemented by this object.
default @NonNull Map<SupportingLinkKey,SupportingLink>	nonnullSupportingLink()	Return supportingLink, or an empty list if it is not present.
default @NonNull LinkId	requireLinkId()	Return linkId, guaranteed to be non-null.

Field Detail

QNAME

static final @NonNull QName QNAME

Method Detail

implementedInterface

Class<? extends LinkAttributes> implementedInterface()

Description copied from interface: DataContainer

Return the interface implemented by this object. This method differs from Object.getClass() in that it returns the interface contract, not a concrete implementation class.

Specified by:

implementedInterface in interface DataContainer

Specified by:

implementedInterface in interface DataObject

Returns:

Implemented contract

getLinkId

LinkId getLinkId()

Return linkId, or null if it is not present.

     
         The identifier of a link in the topology. A link is specific to a topology to
         which it belongs.
     
 

Returns:

LinkId linkId, or null if it is not present.

requireLinkId

default @NonNull LinkId requireLinkId()

Return linkId, guaranteed to be non-null.

     
         The identifier of a link in the topology. A link is specific to a topology to
         which it belongs.
     
 

Returns:

LinkId linkId, guaranteed to be non-null.

Throws:

NoSuchElementException - if linkId is not present

getSource

Source getSource()

Return source, or null if it is not present.

Returns:

Source source, or null if it is not present.

getDestination

Destination getDestination()

Return destination, or null if it is not present.

Returns:

Destination destination, or null if it is not present.

getSupportingLink

@Nullable Map<SupportingLinkKey,SupportingLink> getSupportingLink()

Return supportingLink, or null if it is not present.

Returns:

Map<SupportingLinkKey, SupportingLink> supportingLink, or null if it is not present.

nonnullSupportingLink

default @NonNull Map<SupportingLinkKey,SupportingLink> nonnullSupportingLink()

Return supportingLink, or an empty list if it is not present.

Returns:

Map<SupportingLinkKey, SupportingLink> supportingLink, or an empty list if it is not present.