Interface PathConstraints

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

    @Generated("mdsal-binding-generator")
    public interface PathConstraints
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Set of Constraints for Path Computation

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

     grouping path-constraints {
       leaf metric {
         type uint32;
       }
       leaf te-metric {
         type uint32;
       }
       leaf delay {
         type gr:delay;
       }
       leaf jitter {
         type gr:delay;
       }
       leaf loss {
         type gr:loss;
       }
       leaf admin-group {
         type uint32;
       }
       leaf address-family {
         type enumeration {
           enum ipv4 {
             value 0;
           }
           enum ipv6 {
             value 1;
           }
           enum sr-ipv4 {
             value 2;
           }
           enum sr-ipv6 {
             value 3;
           }
         }
         default ipv4;
       }
       leaf class-type {
         type uint8 {
           range 0..7;
         }
       }
       leaf bandwidth {
         type gr:decimal-bandwidth;
       }
     }
     
    The schema path to identify an instance is path-computation/path-constraints
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        org.opendaylight.yangtools.yang.common.Uint32 getMetric()
        Return metric, or null if it is not present.
             
                 Maximum end to end IGP metric
             
         
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 metric, or null if it is not present.
      • getTeMetric

        org.opendaylight.yangtools.yang.common.Uint32 getTeMetric()
        Return teMetric, or null if it is not present.
             
                 Maximum end to end Traffic Engineering metric
             
         
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 teMetric, or null if it is not present.
      • getDelay

        Delay getDelay()
        Return delay, or null if it is not present.
             
                 Maximum end to end delay
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.Delay delay, or null if it is not present.
      • getJitter

        Delay getJitter()
        Return jitter, or null if it is not present.
             
                 Maximum delay variation for selected edges
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.Delay jitter, or null if it is not present.
      • getLoss

        Loss getLoss()
        Return loss, or null if it is not present.
             
                 Maximum loss for selected edges
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.Loss loss, or null if it is not present.
      • getAdminGroup

        org.opendaylight.yangtools.yang.common.Uint32 getAdminGroup()
        Return adminGroup, or null if it is not present.
             
                 Admin group to select edges
             
         
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 adminGroup, or null if it is not present.
      • getAddressFamily

        PathConstraints.AddressFamily getAddressFamily()
        Return addressFamily, or null if it is not present.
             
                 Address family of the computed path
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120.PathConstraints.AddressFamily addressFamily, or null if it is not present.
      • getClassType

        org.opendaylight.yangtools.yang.common.Uint8 getClassType()
        Return classType, or null if it is not present.
             
                 Class Type for bandwidth constraints
             
         
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 classType, or null if it is not present.
      • getBandwidth

        DecimalBandwidth getBandwidth()
        Return bandwidth, or null if it is not present.
             
                 Requested bandwidth for the computed path
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.DecimalBandwidth bandwidth, or null if it is not present.