Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120

Interface OpenMessage

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:

Open, OpenMsg, PduOpenTlv, ReceivedOpen, SentOpen

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

Open Message

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

 grouping open-message {
   leaf version {
     type protocol-version;
     default 4;
   }
   leaf my-as-number {
     type uint16;
     default 23456;
   }
   leaf hold-timer {
     type uint16;
   }
   leaf bgp-identifier {
     type inet:ipv4-address-no-zone;
   }
   list bgp-parameters {
     list optional-capabilities {
       container c-parameters {
         container as4-bytes-capability {
           leaf as-number {
             type inet:as-number;
           }
         }
         container bgp-extended-message-capability {
           presence "Indicates peer is able to send/receive 64K messages";
         }
       }
     }
   }
 }
 

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
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone	getBgpIdentifier()	Return bgpIdentifier, or null if it is not present.
@Nullable List<BgpParameters>	getBgpParameters()	Return bgpParameters, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint16	getHoldTimer()	Return holdTimer, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint16	getMyAsNumber()	Return myAsNumber, or null if it is not present.
ProtocolVersion	getVersion()	Return version, or null if it is not present.
Class<? extends OpenMessage>	implementedInterface()
default @NonNull List<BgpParameters>	nonnullBgpParameters()	Return bgpParameters, or an empty list if it is not present.
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone	requireBgpIdentifier()	Return bgpIdentifier, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint16	requireHoldTimer()	Return holdTimer, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint16	requireMyAsNumber()	Return myAsNumber, guaranteed to be non-null.
default @NonNull ProtocolVersion	requireVersion()	Return version, 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 OpenMessage> 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

getVersion

ProtocolVersion getVersion()

Return version, or null if it is not present.

Returns:

ProtocolVersion version, or null if it is not present.

requireVersion

default @NonNull ProtocolVersion requireVersion()

Return version, guaranteed to be non-null.

Returns:

ProtocolVersion version, guaranteed to be non-null.

Throws:

NoSuchElementException - if version is not present

getMyAsNumber

org.opendaylight.yangtools.yang.common.Uint16 getMyAsNumber()

Return myAsNumber, or null if it is not present.

Returns:

Uint16 myAsNumber, or null if it is not present.

requireMyAsNumber

default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireMyAsNumber()

Return myAsNumber, guaranteed to be non-null.

Returns:

Uint16 myAsNumber, guaranteed to be non-null.

Throws:

NoSuchElementException - if myAsNumber is not present

getHoldTimer

org.opendaylight.yangtools.yang.common.Uint16 getHoldTimer()

Return holdTimer, or null if it is not present.

Returns:

Uint16 holdTimer, or null if it is not present.

requireHoldTimer

default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireHoldTimer()

Return holdTimer, guaranteed to be non-null.

Returns:

Uint16 holdTimer, guaranteed to be non-null.

Throws:

NoSuchElementException - if holdTimer is not present

getBgpIdentifier

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getBgpIdentifier()

Return bgpIdentifier, or null if it is not present.

Returns:

Ipv4AddressNoZone bgpIdentifier, or null if it is not present.

requireBgpIdentifier

default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone requireBgpIdentifier()

Return bgpIdentifier, guaranteed to be non-null.

Returns:

Ipv4AddressNoZone bgpIdentifier, guaranteed to be non-null.

Throws:

NoSuchElementException - if bgpIdentifier is not present

getBgpParameters

@Nullable List<BgpParameters> getBgpParameters()

Return bgpParameters, or null if it is not present.

Returns:

List<BgpParameters> bgpParameters, or null if it is not present.

nonnullBgpParameters

default @NonNull List<BgpParameters> nonnullBgpParameters()

Return bgpParameters, or an empty list if it is not present.

Returns:

List<BgpParameters> bgpParameters, or an empty list if it is not present.