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

Interface SupportingNetwork

All Superinterfaces:

Augmentable<SupportingNetwork>, BindingObject, ChildOf<Network>, DataContainer, DataObject, Identifiable<SupportingNetworkKey>

public interface SupportingNetwork
extends ChildOf<Network>, Augmentable<SupportingNetwork>, Identifiable<SupportingNetworkKey>

An underlay network, used to represent layered network topologies.

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

 list supporting-network {
   key network-ref;
   leaf network-ref {
     type leafref {
       path /nw-s:networks/nw-s:network/nw-s:network-id;
       require-instance false;
     }
   }
 }
 

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

To create instances of this class use SupportingNetworkBuilder.

See Also:

SupportingNetworkBuilder, SupportingNetworkKey

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	getNetworkRef() References the underlay network.
SupportingNetworkKey	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

getNetworkRef

@Nullable NetworkId getNetworkRef()

References the underlay network.

Returns:

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

key

SupportingNetworkKey key()

Description copied from interface: Identifiable

Returns an unique key for the object.

Specified by:

key in interface Identifiable<SupportingNetworkKey>

Returns:

Key for the object