Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.operational.rev151009

Interface BgpNeighborState

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

All Known Subinterfaces:

NeighborStateAugmentation, State8

@Generated("mdsal-binding-generator")
public interface BgpNeighborState
extends org.opendaylight.yangtools.yang.binding.DataObject

Grouping containing operational state variables relating to a BGP neighbor

This class represents the following YANG schema fragment defined in module openconfig-bgp-operational

 grouping bgp-neighbor_state {
   leaf session-state {
     type enumeration {
       enum IDLE {
       }
       enum CONNECT {
       }
       enum ACTIVE {
       }
       enum OPENSENT {
       }
       enum OPENCONFIRM {
       }
       enum ESTABLISHED {
       }
     }
   }
   leaf-list supported-capabilities {
     type identityref {
       base bgp-capability;
     }
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BgpNeighborState.SessionState	This class represents the following YANG schema fragment defined in module openconfig-bgp-operational

Field Summary

Fields

Modifier and Type	Field	Description
static final @NonNull org.opendaylight.yangtools.yang.common.QName	QNAME	YANG identifier of the statement represented by this class.

Method Summary

Modifier and Type	Method	Description
BgpNeighborState.SessionState	getSessionState()	Return sessionState, or null if it is not present.
@Nullable Set<BgpCapability>	getSupportedCapabilities()	Return supportedCapabilities, or null if it is not present.
Class<? extends BgpNeighborState>	implementedInterface()
default @NonNull BgpNeighborState.SessionState	requireSessionState()	Return sessionState, guaranteed to be non-null.
default @NonNull Set<BgpCapability>	requireSupportedCapabilities()	Return supportedCapabilities, guaranteed to be non-null.

Field Details

QNAME

static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

YANG identifier of the statement represented by this class.

Method Details

implementedInterface

Class<? extends BgpNeighborState> implementedInterface()

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

getSessionState

BgpNeighborState.SessionState getSessionState()

Return sessionState, or null if it is not present.

     
         Operational state of the BGP peer
     
 

Returns:

SessionState sessionState, or null if it is not present.

requireSessionState

default @NonNull BgpNeighborState.SessionState requireSessionState()

Return sessionState, guaranteed to be non-null.

     
         Operational state of the BGP peer
     
 

Returns:

SessionState sessionState, guaranteed to be non-null.

Throws:

NoSuchElementException - if sessionState is not present

getSupportedCapabilities

@Nullable Set<BgpCapability> getSupportedCapabilities()

Return supportedCapabilities, or null if it is not present.

     
         BGP capabilities negotiated as supported with the peer
     
 

Returns:

Set<BgpCapability> supportedCapabilities, or null if it is not present.

requireSupportedCapabilities

default @NonNull Set<BgpCapability> requireSupportedCapabilities()

Return supportedCapabilities, guaranteed to be non-null.

     
         BGP capabilities negotiated as supported with the peer
     
 

Returns:

Set<BgpCapability> supportedCapabilities, guaranteed to be non-null.

Throws:

NoSuchElementException - if supportedCapabilities is not present