Interface Prefix

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    Prefix

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

    This class represents the following YANG schema fragment defined in module graph

     grouping prefix {
       leaf prefix {
         type inet:ip-prefix;
       }
       leaf prefix-sid {
         type uint32;
       }
       leaf node-sid {
         type boolean;
       }
       leaf vertex-id {
         type uint64;
       }
     }
     
    The schema path to identify an instance is graphprefix
    • 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
      Boolean getNodeSid()
      Return nodeSid, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
      Return prefix, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getPrefixSid()
      Return prefixSid, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint64 getVertexId()
      Return vertexId, or null if it is not present.
      Class<? extends Prefix> implementedInterface()  
      default @NonNull Boolean requireNodeSid()
      Return nodeSid, guaranteed to be non-null.
      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix requirePrefix()
      Return prefix, guaranteed to be non-null.
      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requirePrefixSid()
      Return prefixSid, guaranteed to be non-null.
      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireVertexId()
      Return vertexId, guaranteed to be non-null.
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
        Return prefix, or null if it is not present.
             
                 IP (v4 or v6) Prefix.
             
         
        Returns:
        IpPrefix prefix, or null if it is not present.
      • requirePrefix

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix requirePrefix()
        Return prefix, guaranteed to be non-null.
             
                 IP (v4 or v6) Prefix.
             
         
        Returns:
        IpPrefix prefix, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if prefix is not present
      • getPrefixSid

        org.opendaylight.yangtools.yang.common.Uint32 getPrefixSid()
        Return prefixSid, or null if it is not present.
             
                 Segment Routing prefix Identifier. Unit MPLS label
             
         
        Returns:
        Uint32 prefixSid, or null if it is not present.
      • requirePrefixSid

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requirePrefixSid()
        Return prefixSid, guaranteed to be non-null.
             
                 Segment Routing prefix Identifier. Unit MPLS label
             
         
        Returns:
        Uint32 prefixSid, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if prefixSid is not present
      • getNodeSid

        Boolean getNodeSid()
        Return nodeSid, or null if it is not present.
             
                 Prefix is a Node Segment Routing Identifier (Node-SID)
             
         
        Returns:
        Boolean nodeSid, or null if it is not present.
      • requireNodeSid

        default @NonNull Boolean requireNodeSid()
        Return nodeSid, guaranteed to be non-null.
             
                 Prefix is a Node Segment Routing Identifier (Node-SID)
             
         
        Returns:
        Boolean nodeSid, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if nodeSid is not present
      • getVertexId

        org.opendaylight.yangtools.yang.common.Uint64 getVertexId()
        Return vertexId, or null if it is not present.
             
                 Reference to the Vertex where the prefix is attached
             
         
        Returns:
        Uint64 vertexId, or null if it is not present.
      • requireVertexId

        default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireVertexId()
        Return vertexId, guaranteed to be non-null.
             
                 Reference to the Vertex where the prefix is attached
             
         
        Returns:
        Uint64 vertexId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if vertexId is not present