org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev180313.routing.control.plane.protocols

Interface ControlPlaneProtocol

All Superinterfaces:

Augmentable<ControlPlaneProtocol>, BindingObject, ChildOf<ControlPlaneProtocols>, DataContainer, DataObject, Identifiable<ControlPlaneProtocolKey>

public interface ControlPlaneProtocol
extends ChildOf<ControlPlaneProtocols>, Augmentable<ControlPlaneProtocol>, Identifiable<ControlPlaneProtocolKey>

Each entry contains a control-plane protocol instance.

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

 list control-plane-protocol {
   key "type name";
   leaf type {
     type identityref {
       base control-plane-protocol;
     }
   }
   leaf name {
     type string;
   }
   leaf description {
     type string;
   }
   container static-routes {
     when "derived-from-or-self(../type, 'rt:static')" {
     }
   }
 }
 

The schema path to identify an instance is ietf-routing/routing/control-plane-protocols/control-plane-protocol

To create instances of this class use ControlPlaneProtocolBuilder.

See Also:

ControlPlaneProtocolBuilder, ControlPlaneProtocolKey

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 String	getDescription() Textual description of the control-plane protocolinstance.
@Nullable String	getName() An arbitrary name of the control-plane protocolinstance.
@Nullable StaticRoutes	getStaticRoutes() Support for the 'static' pseudo-protocol.Address-family-specific modules augment this node withtheir lists of routes.
@Nullable Class<? extends ControlPlaneProtocol>	getType() Type of the control-plane protocol -- an identityderived from the 'control-plane-protocol'base identity.
ControlPlaneProtocolKey	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

getType

@Nullable Class<? extends ControlPlaneProtocol> getType()

Type of the control-plane protocol -- an identityderived from the 'control-plane-protocol'base identity.

Returns:

java.lang.Class type, or null if not present

getName

@Nullable String getName()

An arbitrary name of the control-plane protocolinstance.

Returns:

java.lang.String name, or null if not present

getDescription

@Nullable String getDescription()

Textual description of the control-plane protocolinstance.

Returns:

java.lang.String description, or null if not present

getStaticRoutes

@Nullable StaticRoutes getStaticRoutes()

Support for the 'static' pseudo-protocol.Address-family-specific modules augment this node withtheir lists of routes.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev180313.routing.control.plane.protocols.control.plane.protocol.StaticRoutes staticRoutes, or null if not present

key

ControlPlaneProtocolKey key()

Description copied from interface: Identifiable

Returns an unique key for the object.

Specified by:

key in interface Identifiable<ControlPlaneProtocolKey>

Returns:

Key for the object