Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.proc.time.object

Interface ProcTime

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

    This class represents the following YANG schema fragment defined in module pcep-types 

     container proc-time {
   uses object;
   leaf estimated {
     type boolean;
   }
   leaf current-proc-time {
     type uint32;
   }
   leaf min-proc-time {
     type uint32;
   }
   leaf max-proc-time {
     type uint32;
   }
   leaf average-proc-time {
     type uint32;
   }
   leaf variance-proc-time {
     type uint32;
   }
 }

    To create instances of this class use ProcTimeBuilder.

    See Also:
    ProcTimeBuilder

    • 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<ProcTime> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
        Specified by:
        implementedInterface in interface Object
        Specified by:
        implementedInterface in interface ObjectHeader

      • bindingHashCode

        static int bindingHashCode​(@NonNull ProcTime 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 ProcTime thisObj,
                             Object obj)
        Default implementation of Object.equals(java.lang.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 ProcTime 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

      • getEstimated

        Boolean getEstimated()
        Return estimated, or null if it is not present. 
             
         Indicates that the reported metric value is based on estimated processing time
         as opposed to actual computations.
        Returns:
        Boolean estimated, or null if it is not present.

      • requireEstimated

        default @NonNull Boolean requireEstimated()
        Return estimated, guaranteed to be non-null. 
             
         Indicates that the reported metric value is based on estimated processing time
         as opposed to actual computations.
        Returns:
        Boolean estimated, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if estimated is not present

      • getCurrentProcTime

        org.opendaylight.yangtools.yang.common.Uint32 getCurrentProcTime()
        Return currentProcTime, or null if it is not present. 
             
         Indicates, in milliseconds, the processing time for the path computation of
         interest characterized in the corresponding PCMonReq message.
        Returns:
        Uint32 currentProcTime, or null if it is not present.

      • requireCurrentProcTime

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireCurrentProcTime()
        Return currentProcTime, guaranteed to be non-null. 
             
         Indicates, in milliseconds, the processing time for the path computation of
         interest characterized in the corresponding PCMonReq message.
        Returns:
        Uint32 currentProcTime, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if currentProcTime is not present

      • getMinProcTime

        org.opendaylight.yangtools.yang.common.Uint32 getMinProcTime()
        Return minProcTime, or null if it is not present. 
             
         The minimum processing time in milliseconds
        Returns:
        Uint32 minProcTime, or null if it is not present.

      • requireMinProcTime

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireMinProcTime()
        Return minProcTime, guaranteed to be non-null. 
             
         The minimum processing time in milliseconds
        Returns:
        Uint32 minProcTime, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if minProcTime is not present

      • getMaxProcTime

        org.opendaylight.yangtools.yang.common.Uint32 getMaxProcTime()
        Return maxProcTime, or null if it is not present. 
             
         The maximum processing time in milliseconds
        Returns:
        Uint32 maxProcTime, or null if it is not present.

      • requireMaxProcTime

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireMaxProcTime()
        Return maxProcTime, guaranteed to be non-null. 
             
         The maximum processing time in milliseconds
        Returns:
        Uint32 maxProcTime, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if maxProcTime is not present

      • getAverageProcTime

        org.opendaylight.yangtools.yang.common.Uint32 getAverageProcTime()
        Return averageProcTime, or null if it is not present. 
             
         The average processing time in milliseconds
        Returns:
        Uint32 averageProcTime, or null if it is not present.

      • requireAverageProcTime

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireAverageProcTime()
        Return averageProcTime, guaranteed to be non-null. 
             
         The average processing time in milliseconds
        Returns:
        Uint32 averageProcTime, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if averageProcTime is not present

      • getVarianceProcTime

        org.opendaylight.yangtools.yang.common.Uint32 getVarianceProcTime()
        Return varianceProcTime, or null if it is not present. 
             
         The variance of processing times in milliseconds
        Returns:
        Uint32 varianceProcTime, or null if it is not present.

      • requireVarianceProcTime

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireVarianceProcTime()
        Return varianceProcTime, guaranteed to be non-null. 
             
         The variance of processing times in milliseconds
        Returns:
        Uint32 varianceProcTime, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if varianceProcTime is not present