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

Interface SupportingNode

All Superinterfaces:

Augmentable<SupportingNode>, BindingObject, ChildOf<NodeAttributes>, DataContainer, DataObject, Identifiable<SupportingNodeKey>

public interface SupportingNode
extends ChildOf<NodeAttributes>, Augmentable<SupportingNode>, Identifiable<SupportingNodeKey>

This list defines vertical layering information for nodes. It allows to capture for any given node, which node (or nodes) in the corresponding underlay it maps onto. A node can map to zero, one, or more nodes below it; accordingly there can be zero, one, or more elements in the list. If there are specific layering requirements, for example specific to a particular type of topology that only allows for certain layering relationships, the choice below can be augmented with additional cases. A list has been chosen rather than a leaf-list in order to provide room for augmentations, e.g. for statistics or priorization information associated with supporting nodes.

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

 list supporting-node {
   key "topology-ref node-ref";
   leaf topology-ref {
     type topology-ref;
   }
   leaf node-ref {
     type node-ref;
   }
 }
 

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

To create instances of this class use SupportingNodeBuilder.

See Also:

SupportingNodeBuilder, SupportingNodeKey

Field Summary

Fields

Modifier and Type	Field and Description
static org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method and Description
@Nullable NodeId	getNodeRef()
@Nullable TopologyId	getTopologyRef()
SupportingNodeKey	key() Returns an unique key for the object.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.DataContainer

getImplementedInterface

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation

Field Detail

QNAME

static final org.opendaylight.yangtools.yang.common.QName QNAME

Method Detail

getTopologyRef

@Nullable TopologyId getTopologyRef()

Returns:

org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId topologyRef, or null if not present

getNodeRef

@Nullable NodeId getNodeRef()

Returns:

org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId nodeRef, or null if not present

key

SupportingNodeKey key()

Description copied from interface: Identifiable

Returns an unique key for the object.

Specified by:

key in interface Identifiable<SupportingNodeKey>

Returns:

Key for the object