org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.state.rev180226.networks.network

Interface Link

All Superinterfaces:

Augmentable<Link>, BindingObject, ChildOf<Network1>, DataContainer, DataObject, Identifiable<LinkKey>

public interface Link
extends ChildOf<Network1>, Augmentable<Link>, Identifiable<LinkKey>

A network link connects a local (source) node and a remote (destination) node via a set of the respective node's termination points. It is possible to have several links between the same source and destination nodes. Likewise, a link could potentially be re-homed between termination points. Therefore, in order ensure that we would always know to distinguish between links, every link is identified by a dedicated link identifier. Note that a link models a point-to-point link, not a multipoint link.

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

 list link {
   key link-id;
   container source {
     leaf source-node {
       type leafref {
         path ../../../nw-s:node/nw-s:node-id;
         require-instance false;
       }
     }
     leaf source-tp {
       type leafref {
         path ../../../nw-s:node[nw-s:node-id=current()/../source-node]/termination-point/tp-id;
         require-instance false;
       }
     }
   }
   container destination {
     leaf dest-node {
       type leafref {
         path ../../../nw-s:node/nw-s:node-id;
         require-instance false;
       }
     }
     leaf dest-tp {
       type leafref {
         path ../../../nw-s:node[nw-s:node-id=current()/../dest-node]/termination-point/tp-id;
         require-instance false;
       }
     }
   }
   leaf link-id {
     type nt:link-id;
   }
   list supporting-link {
     key "network-ref link-ref";
     leaf network-ref {
       type leafref {
         path ../../../nw-s:supporting-network/nw-s:network-ref;
         require-instance false;
       }
     }
     leaf link-ref {
       type leafref {
         path /nw-s:networks/nw-s:network[nw-s:network-id=current()/../network-ref]/link/link-id;
         require-instance false;
       }
     }
   }
 }
 

The schema path to identify an instance is ietf-network-topology-state/networks/network/(urn:ietf:params:xml:ns:yang:ietf-network-topology-state?revision=2018-02-26)link

To create instances of this class use LinkBuilder.

See Also:

LinkBuilder, LinkKey

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 Destination	getDestination() This container holds the logical destination of aparticular link.
@Nullable LinkId	getLinkId() The identifier of a link in the topology.A link is specific to a topology to which it belongs.
@Nullable Source	getSource() This container holds the logical source of a particularlink.
@Nullable List<SupportingLink>	getSupportingLink() Identifies the link or links on which this link depends.
LinkKey	key() Returns an unique key for the object.
default @NonNull List<SupportingLink>	nonnullSupportingLink()

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

getSource

@Nullable Source getSource()

This container holds the logical source of a particularlink.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.state.rev180226.networks.network.link.Source source, or null if not present

getDestination

@Nullable Destination getDestination()

This container holds the logical destination of aparticular link.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.state.rev180226.networks.network.link.Destination destination, or null if not present

getLinkId

@Nullable LinkId getLinkId()

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

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId linkId, or null if not present

getSupportingLink

@Nullable List<SupportingLink> getSupportingLink()

Identifies the link or links on which this link depends.

Returns:

java.util.List supportingLink, or null if not present

nonnullSupportingLink

default @NonNull List<SupportingLink> nonnullSupportingLink()

Returns:

java.util.List supportingLink, or an empty list if it is not present

key

LinkKey key()

Description copied from interface: Identifiable

Returns an unique key for the object.

Specified by:

key in interface Identifiable<LinkKey>

Returns:

Key for the object