Interface Vertex

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

    @Generated("mdsal-binding-generator")
    public interface Vertex
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Vertex (node) representation for the network topology

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

     grouping vertex {
       leaf vertex-id {
         type uint64;
       }
       leaf name {
         type string;
       }
       leaf router-id {
         type inet:ip-address;
       }
       leaf vertex-type {
         type enumeration {
           enum standard {
             value 0;
           }
           enum abr {
             value 1;
           }
           enum asbr-in {
             value 2;
           }
           enum asbr-out {
             value 3;
           }
           enum pseudo {
             value 4;
           }
         }
         default standard;
       }
       container srgb {
         uses srgb;
       }
       leaf asn {
         type uint32;
       }
     }
     
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  Vertex.VertexType  
    • 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 Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      org.opendaylight.yangtools.yang.common.Uint32 getAsn()
      Return asn, or null if it is not present.
      String getName()
      Return name, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getRouterId()
      Return routerId, or null if it is not present.
      Srgb getSrgb()
      Return srgb, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint64 getVertexId()
      Return vertexId, or null if it is not present.
      Vertex.VertexType getVertexType()
      Return vertexType, or null if it is not present.
      Class<? extends Vertex> implementedInterface()  
      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireAsn()
      Return asn, guaranteed to be non-null.
      default @NonNull String requireName()
      Return name, guaranteed to be non-null.
      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireRouterId()
      Return routerId, guaranteed to be non-null.
      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireVertexId()
      Return vertexId, guaranteed to be non-null.
      default @NonNull Vertex.VertexType requireVertexType()
      Return vertexType, guaranteed to be non-null.
    • 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

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

        org.opendaylight.yangtools.yang.common.Uint64 getVertexId()
        Return vertexId, or null if it is not present.
             
                 Identifier of the Vertex
             
         
        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.
             
                 Identifier of the Vertex
             
         
        Returns:
        Uint64 vertexId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if vertexId is not present
      • getName

        String getName()
        Return name, or null if it is not present.
             
                 Name of the Vertex when known
             
         
        Returns:
        String name, or null if it is not present.
      • requireName

        default @NonNull String requireName()
        Return name, guaranteed to be non-null.
             
                 Name of the Vertex when known
             
         
        Returns:
        String name, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if name is not present
      • getRouterId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getRouterId()
        Return routerId, or null if it is not present.
             
                 Global unique IP Trafic Engineering Router ID
             
         
        Returns:
        IpAddress routerId, or null if it is not present.
      • requireRouterId

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireRouterId()
        Return routerId, guaranteed to be non-null.
             
                 Global unique IP Trafic Engineering Router ID
             
         
        Returns:
        IpAddress routerId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if routerId is not present
      • getVertexType

        Vertex.VertexType getVertexType()
        Return vertexType, or null if it is not present.
        Returns:
        VertexType vertexType, or null if it is not present.
      • requireVertexType

        default @NonNull Vertex.VertexType requireVertexType()
        Return vertexType, guaranteed to be non-null.
        Returns:
        VertexType vertexType, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if vertexType is not present
      • getSrgb

        Srgb getSrgb()
        Return srgb, or null if it is not present.
             
                 Segment Routing Global Block
             
         
        Returns:
        Srgb srgb, or null if it is not present.
      • getAsn

        org.opendaylight.yangtools.yang.common.Uint32 getAsn()
        Return asn, or null if it is not present.
             
                 AS Number
             
         
        Returns:
        Uint32 asn, or null if it is not present.
      • requireAsn

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireAsn()
        Return asn, guaranteed to be non-null.
             
                 AS Number
             
         
        Returns:
        Uint32 asn, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if asn is not present