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

Interface Network

All Superinterfaces:

Augmentable<Network>, BindingObject, ChildOf<Networks>, DataContainer, DataObject, Identifiable<NetworkKey>

public interface Network
extends ChildOf<Networks>, Augmentable<Network>, Identifiable<NetworkKey>

Describes a network. A network typically contains an inventory of nodes, topological information (augmented through the network-topology data model), layering information.

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

 list network {
   key network-id;
   leaf network-id {
     type network-id;
   }
   container network-types {
   }
   list supporting-network {
     key network-ref;
     leaf network-ref {
       type leafref {
         path /nw:networks/nw:network/nw:network-id;
         require-instance false;
       }
     }
   }
   list node {
     key node-id;
     leaf node-id {
       type node-id;
     }
     list supporting-node {
       key "network-ref node-ref";
       leaf network-ref {
         type leafref {
           path ../../../nw:supporting-network/nw:network-ref;
           require-instance false;
         }
       }
       leaf node-ref {
         type leafref {
           path /nw:networks/nw:network/nw:node/nw:node-id;
           require-instance false;
         }
       }
     }
   }
 }
 

The schema path to identify an instance is ietf-network/networks/network

To create instances of this class use NetworkBuilder.

See Also:

NetworkBuilder, NetworkKey

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 NetworkId	getNetworkId() Identifies a network.
@Nullable NetworkTypes	getNetworkTypes() Serves as an augmentation target.The network type is indicated through correspondingpresence containers augmented into this container.
@Nullable List<Node>	getNode() The inventory of nodes of this network.
@Nullable List<SupportingNetwork>	getSupportingNetwork() An underlay network, used to represent layered networktopologies.
NetworkKey	key() Returns an unique key for the object.
default @NonNull List<Node>	nonnullNode()
default @NonNull List<SupportingNetwork>	nonnullSupportingNetwork()

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

getNetworkId

@Nullable NetworkId getNetworkId()

Identifies a network.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NetworkId networkId, or null if not present

getNetworkTypes

@Nullable NetworkTypes getNetworkTypes()

Serves as an augmentation target.The network type is indicated through correspondingpresence containers augmented into this container.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.NetworkTypes networkTypes, or null if not present

getSupportingNetwork

@Nullable List<SupportingNetwork> getSupportingNetwork()

An underlay network, used to represent layered networktopologies.

Returns:

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

nonnullSupportingNetwork

default @NonNull List<SupportingNetwork> nonnullSupportingNetwork()

Returns:

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

getNode

@Nullable List<Node> getNode()

The inventory of nodes of this network.

Returns:

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

nonnullNode

default @NonNull List<Node> nonnullNode()

Returns:

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

key

NetworkKey key()

Description copied from interface: Identifiable

Returns an unique key for the object.

Specified by:

key in interface Identifiable<NetworkKey>

Returns:

Key for the object