Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125

Interface Edge

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    Edge
    @Generated("mdsal-binding-generator")
public interface Edge
extends org.opendaylight.yangtools.yang.binding.DataObject
    Unidirectional Edge (link) representation for the network topology

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

     grouping edge {
   leaf edge-id {
     type uint64;
   }
   leaf local-vertex-id {
     type uint64;
   }
   leaf remote-vertex-id {
     type uint64;
   }
   leaf name {
     type string;
   }
   container edge-attributes {
     uses edge-attributes;
   }
 }
    The schema path to identify an instance is graphedge

    • Field Summary

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

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • getEdgeId

        org.opendaylight.yangtools.yang.common.Uint64 getEdgeId()
        Return edgeId, or null if it is not present.
        Returns:
        Uint64 edgeId, or null if it is not present.

      • requireEdgeId

        default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireEdgeId()
        Return edgeId, guaranteed to be non-null.
        Returns:
        Uint64 edgeId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if edgeId is not present

      • getLocalVertexId

        org.opendaylight.yangtools.yang.common.Uint64 getLocalVertexId()
        Return localVertexId, or null if it is not present. 
             
         Vertex identifier where the Edge is attached
        Returns:
        Uint64 localVertexId, or null if it is not present.

      • requireLocalVertexId

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

      • getRemoteVertexId

        org.opendaylight.yangtools.yang.common.Uint64 getRemoteVertexId()
        Return remoteVertexId, or null if it is not present. 
             
         Vertex identifier where the Edge is going to
        Returns:
        Uint64 remoteVertexId, or null if it is not present.

      • requireRemoteVertexId

        default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireRemoteVertexId()
        Return remoteVertexId, guaranteed to be non-null. 
             
         Vertex identifier where the Edge is going to
        Returns:
        Uint64 remoteVertexId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if remoteVertexId is not present

      • getName

        String getName()
        Return name, or null if it is not present. 
             
         Edge name
        Returns:
        String name, or null if it is not present.

      • requireName

        default @NonNull String requireName()
        Return name, guaranteed to be non-null. 
             
         Edge name
        Returns:
        String name, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if name is not present

      • getEdgeAttributes

        EdgeAttributes getEdgeAttributes()
        Return edgeAttributes, or null if it is not present. 
             
         All attributes associated to the Edge
        Returns:
        EdgeAttributes edgeAttributes, or null if it is not present.