Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120

Interface SrDescription

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    PathDescription
    @Generated("mdsal-binding-generator")
public interface SrDescription
extends org.opendaylight.yangtools.yang.binding.DataObject
    Segment Routing path description

    This class represents the following YANG schema fragment defined in module path-computation 

     grouping sr-description {
   leaf sid {
     when "path-constraints/address-family = 2 or path-constraints/address-family = 3";
     type uint32;
   }
   leaf local-ipv4 {
     when "path-constraints/address-family = 2";
     type inet:ipv4-address;
   }
   leaf remote-ipv4 {
     when "path-constraints/address-family = 2";
     type inet:ipv4-address;
   }
   leaf local-ipv6 {
     when "path-constraints/address-family = 3";
     type inet:ipv6-address;
   }
   leaf remote-ipv6 {
     when "path-constraints/address-family = 3";
     type inet:ipv6-address;
   }
 }
    The schema path to identify an instance is path-computationsr-description

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getLocalIpv4()
      Return localIpv4, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getLocalIpv6()
      Return localIpv6, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getRemoteIpv4()
      Return remoteIpv4, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getRemoteIpv6()
      Return remoteIpv6, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getSid()
      Return sid, or null if it is not present.
      Class<? extends SrDescription> implementedInterface()  
      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address requireLocalIpv4()
      Return localIpv4, guaranteed to be non-null.
      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address requireLocalIpv6()
      Return localIpv6, guaranteed to be non-null.
      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address requireRemoteIpv4()
      Return remoteIpv4, guaranteed to be non-null.
      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address requireRemoteIpv6()
      Return remoteIpv6, guaranteed to be non-null.
      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireSid()
      Return sid, guaranteed to be non-null.

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        Class<? extends SrDescription> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • getSid

        org.opendaylight.yangtools.yang.common.Uint32 getSid()
        Return sid, or null if it is not present. 
             
         Segment Routing Identifier as an Index or MPLS label
        Returns:
        Uint32 sid, or null if it is not present.

      • requireSid

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireSid()
        Return sid, guaranteed to be non-null. 
             
         Segment Routing Identifier as an Index or MPLS label
        Returns:
        Uint32 sid, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if sid is not present

      • getLocalIpv4

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getLocalIpv4()
        Return localIpv4, or null if it is not present. 
             
         Local IPv4 address
        Returns:
        Ipv4Address localIpv4, or null if it is not present.

      • requireLocalIpv4

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address requireLocalIpv4()
        Return localIpv4, guaranteed to be non-null. 
             
         Local IPv4 address
        Returns:
        Ipv4Address localIpv4, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if localIpv4 is not present

      • getRemoteIpv4

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getRemoteIpv4()
        Return remoteIpv4, or null if it is not present. 
             
         Remote IPv4 address
        Returns:
        Ipv4Address remoteIpv4, or null if it is not present.

      • requireRemoteIpv4

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address requireRemoteIpv4()
        Return remoteIpv4, guaranteed to be non-null. 
             
         Remote IPv4 address
        Returns:
        Ipv4Address remoteIpv4, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if remoteIpv4 is not present

      • getLocalIpv6

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getLocalIpv6()
        Return localIpv6, or null if it is not present. 
             
         Local IPv6 address
        Returns:
        Ipv6Address localIpv6, or null if it is not present.

      • requireLocalIpv6

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address requireLocalIpv6()
        Return localIpv6, guaranteed to be non-null. 
             
         Local IPv6 address
        Returns:
        Ipv6Address localIpv6, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if localIpv6 is not present

      • getRemoteIpv6

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getRemoteIpv6()
        Return remoteIpv6, or null if it is not present. 
             
         Remote IPv6 address
        Returns:
        Ipv6Address remoteIpv6, or null if it is not present.

      • requireRemoteIpv6

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address requireRemoteIpv6()
        Return remoteIpv6, guaranteed to be non-null. 
             
         Remote IPv6 address
        Returns:
        Ipv6Address remoteIpv6, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if remoteIpv6 is not present