Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329

Interface Route

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, PathAttributes, PathIdGrouping
All Known Subinterfaces:
BgpRibRoute, BgpRibRoute, BgpRibRoute, EvpnRoute, FlowspecIpv4RouteList, FlowspecIpv6RouteList, FlowspecL3vpnRoute, FlowspecL3vpnRoute, FlowspecRoute, FlowspecRoute, Ipv4Route, Ipv4Route, Ipv6Route, L3vpnMcastRoute, LabeledUnicastRoute, LinkstateRoute, MvpnBgpRibRoute, MvpnRoute, RouteTargetConstrainRoute, VpnRoute
@Generated("mdsal-binding-generator") public interface Route extends org.opendaylight.yangtools.yang.binding.DataObject, PathIdGrouping, PathAttributes

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

 grouping route {
   uses bgp-msg:path-id-grouping;
   leaf route-key {
     type string;
   }
   uses bgp-msg:path-attributes;
 }

  • 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
    String
    getRouteKey()
    Return routeKey, or null if it is not present.
    Class<? extends Route>
    implementedInterface()
     
    default @NonNull String
    requireRouteKey()
    Return routeKey, guaranteed to be non-null.

    Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.PathAttributes

    getAttributes, nonnullAttributes

    Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.PathIdGrouping

    getPathId, requirePathId

  • 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 Route> 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
      Specified by:
      implementedInterface in interface PathAttributes
      Specified by:
      implementedInterface in interface PathIdGrouping

    • getRouteKey

      String getRouteKey()
      Return routeKey, or null if it is not present. 
           
         The sole function of this leaf to act as the key in the list. Its format does
         not form the API contract of this model.
      Returns:
      String routeKey, or null if it is not present.

    • requireRouteKey

      default @NonNull String requireRouteKey()
      Return routeKey, guaranteed to be non-null. 
           
         The sole function of this leaf to act as the key in the list. Its format does
         not form the API contract of this model.
      Returns:
      String routeKey, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if routeKey is not present