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

Interface PathDescription

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<PathDescription>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PathDescriptions>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface PathDescription
extends org.opendaylight.yangtools.yang.binding.ChildOf<PathDescriptions>, org.opendaylight.yangtools.yang.binding.Augmentable<PathDescription>

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

     list path-description {
   leaf ipv4 {
     when "path-constraints/address-family = 0 or path-constraints/address-family = 2";
     type inet:ipv4-address;
   }
   leaf ipv6 {
     when "path-constraints/address-family = 1 or path-constraints/address-family = 3";
     type inet:ipv6-address;
   }
   leaf remote-ipv4 {
     when "path-constraints/address-family = 2";
     type inet:ipv4-address;
   }
   leaf remote-ipv6 {
     when "path-constraints/address-family = 3";
     type inet:ipv6-address;
   }
   leaf sid {
     when "path-constraints/address-family = 2 or path-constraints/address-family = 3";
     type uint32;
   }
 }

    To create instances of this class use PathDescriptionBuilder.

    See Also:
    PathDescriptionBuilder

    • Field Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      static boolean bindingEquals​(@NonNull PathDescription thisObj, Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull PathDescription obj)
      Default implementation of Object.hashCode() contract for this interface.
      static String bindingToString​(@NonNull PathDescription obj)
      Default implementation of Object.toString() contract for this interface.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpv4()
      Return ipv4, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getIpv6()
      Return ipv6, 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.
      default Class<PathDescription> implementedInterface()  
      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address requireIpv4()
      Return ipv4, guaranteed to be non-null.
      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address requireIpv6()
      Return ipv6, 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.

      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation, augmentations

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<PathDescription> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull PathDescription obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull PathDescription thisObj,
                             Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull PathDescription obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • getIpv4

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

      • requireIpv4

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

      • getIpv6

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

      • requireIpv6

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address requireIpv6()
        Return ipv6, guaranteed to be non-null.
        Returns:
        Ipv6Address ipv6, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ipv6 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

      • 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

      • 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