public interface Topology extends ChildOf<NetworkTopology>, Augmentable<Topology>, Identifiable<TopologyKey>
This class represents the following YANG schema fragment defined in module network-topology
list topology { key topology-id; leaf topology-id { type topology-id; } leaf server-provided { type boolean; config false; } container topology-types { } list underlay-topology { key topology-ref; leaf topology-ref { type topology-ref; } } list node { key node-id; uses node-attributes; must boolean(../underlay-topology[*]/node[./supporting-nodes/node-ref]); list termination-point { key tp-id; uses tp-attributes; } } list link { key link-id; uses link-attributes; must boolean(../underlay-topology/link[./supporting-link]); must boolean(../node[./source/source-node]); must boolean(../node[./destination/dest-node]); must boolean(../node/termination-point[./source/source-tp]); must boolean(../node/termination-point[./destination/dest-tp]); } }The schema path to identify an instance is network-topology/network-topology/topology
To create instances of this class use TopologyBuilder
.
TopologyBuilder
,
TopologyKey
Modifier and Type | Field and Description |
---|---|
static org.opendaylight.yangtools.yang.common.QName |
QNAME |
Modifier and Type | Method and Description |
---|---|
@Nullable List<Link> |
getLink()
A Network Link connects a by Local (Source) node anda Remote (Destination)
Network Nodes via a set of thenodes' termination points.As it is possible to
have several links between the samesource and destination nodes, and as a link
could potentiallybe re-homed between termination points, to ensure that wewould
always know to distinguish between links, every linkis identified by a dedicated
link identifier.Note that a link models a point-to-point link, not a
multipointlink.Layering dependencies on links in underlay topologies arenot
represented as the layering information of nodes and oftermination points is
sufficient.
|
@Nullable List<Node> |
getNode()
The list of network nodes defined for the topology.
|
@Nullable TopologyId |
getTopologyId()
It is presumed that a datastore will contain many topologies.
|
@Nullable TopologyTypes |
getTopologyTypes()
This container is used to identify the type, or types(as a topology can support
several types simultaneously),of the topology.Topology types are the subject of
several integrity constraintsthat an implementing server can validate in order
tomaintain integrity of the datastore.Topology types are indicated through
separate data nodes;the set of topology types is expected to increase over
time.To add support for a new topology, an augmenting moduleneeds to augment
this container with a new empty optionalcontainer to indicate the new topology
type.The use of a container allows to indicate a subcategorizationof topology
types.The container SHALL NOT be augmented with any data nodesthat serve a
purpose other than identifying a particulartopology type.
|
@Nullable List<UnderlayTopology> |
getUnderlayTopology()
Identifies the topology, or topologies, that this topologyis dependent on.
|
@Nullable Boolean |
isServerProvided()
Indicates whether the topology is configurable by clients,or whether it is
provided by the server.
|
TopologyKey |
key()
Returns an unique key for the object.
|
default @NonNull List<Link> |
nonnullLink() |
default @NonNull List<Node> |
nonnullNode() |
default @NonNull List<UnderlayTopology> |
nonnullUnderlayTopology() |
getImplementedInterface
augmentation
@Nullable TopologyId getTopologyId()
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId
topologyId
, or null
if not present@Nullable Boolean isServerProvided()
java.lang.Boolean
serverProvided
, or null
if not present@Nullable TopologyTypes getTopologyTypes()
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypes
topologyTypes
, or null
if not present@Nullable List<UnderlayTopology> getUnderlayTopology()
java.util.List
underlayTopology
, or null
if not presentdefault @NonNull List<UnderlayTopology> nonnullUnderlayTopology()
java.util.List
underlayTopology
, or an empty list if it is not present@Nullable List<Node> getNode()
java.util.List
node
, or null
if not presentdefault @NonNull List<Node> nonnullNode()
java.util.List
node
, or an empty list if it is not present@Nullable List<Link> getLink()
java.util.List
link
, or null
if not presentdefault @NonNull List<Link> nonnullLink()
java.util.List
link
, or an empty list if it is not presentTopologyKey key()
Identifiable
key
in interface Identifiable<TopologyKey>
Copyright © 2019 OpenDaylight. All rights reserved.