Interface FlowTestInput

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<FlowTestInput>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.RpcInput

    @Generated("mdsal-binding-generator")
    public interface FlowTestInput
    extends org.opendaylight.yangtools.yang.binding.RpcInput, org.opendaylight.yangtools.yang.binding.Augmentable<FlowTestInput>

    This class represents the following YANG schema fragment defined in module sal-bulk-flow

     input input {
       leaf create-parents {
         type boolean;
         default true;
       }
       leaf is-add {
         type boolean;
       }
       leaf dpn-count {
         type uint32;
       }
       leaf flows-per-dpn {
         type uint32;
       }
       leaf start-table-id {
         type uint32;
       }
       leaf end-table-id {
         type uint32;
       }
       leaf batch-size {
         type uint32;
       }
       leaf seq {
         type boolean;
       }
       leaf tx-chain {
         type boolean;
       }
       leaf sleep-for {
         type uint32;
       }
       leaf sleep-after {
         type uint32;
       }
     }
     
    • 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.
    • 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<FlowTestInput> 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 org.opendaylight.yangtools.yang.binding.RpcInput
      • bindingHashCode

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

        Boolean getCreateParents()
        Return createParents, or null if it is not present.
             
                 Create parents if doesn't exist
             
         
        Returns:
        Boolean createParents, or null if it is not present.
      • requireCreateParents

        default @NonNull Boolean requireCreateParents()
        Return createParents, guaranteed to be non-null.
             
                 Create parents if doesn't exist
             
         
        Returns:
        Boolean createParents, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if createParents is not present
      • getIsAdd

        Boolean getIsAdd()
        Return isAdd, or null if it is not present.
             
                 Add or delete
             
         
        Returns:
        Boolean isAdd, or null if it is not present.
      • requireIsAdd

        default @NonNull Boolean requireIsAdd()
        Return isAdd, guaranteed to be non-null.
             
                 Add or delete
             
         
        Returns:
        Boolean isAdd, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if isAdd is not present
      • getDpnCount

        org.opendaylight.yangtools.yang.common.Uint32 getDpnCount()
        Return dpnCount, or null if it is not present.
             
                 No of DPNs
             
         
        Returns:
        Uint32 dpnCount, or null if it is not present.
      • requireDpnCount

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireDpnCount()
        Return dpnCount, guaranteed to be non-null.
             
                 No of DPNs
             
         
        Returns:
        Uint32 dpnCount, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if dpnCount is not present
      • getFlowsPerDpn

        org.opendaylight.yangtools.yang.common.Uint32 getFlowsPerDpn()
        Return flowsPerDpn, or null if it is not present.
             
                 Flows to be pushed per DPN
             
         
        Returns:
        Uint32 flowsPerDpn, or null if it is not present.
      • requireFlowsPerDpn

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireFlowsPerDpn()
        Return flowsPerDpn, guaranteed to be non-null.
             
                 Flows to be pushed per DPN
             
         
        Returns:
        Uint32 flowsPerDpn, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if flowsPerDpn is not present
      • getStartTableId

        org.opendaylight.yangtools.yang.common.Uint32 getStartTableId()
        Return startTableId, or null if it is not present.
             
                 Start adding flows from this table id
             
         
        Returns:
        Uint32 startTableId, or null if it is not present.
      • requireStartTableId

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireStartTableId()
        Return startTableId, guaranteed to be non-null.
             
                 Start adding flows from this table id
             
         
        Returns:
        Uint32 startTableId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if startTableId is not present
      • getEndTableId

        org.opendaylight.yangtools.yang.common.Uint32 getEndTableId()
        Return endTableId, or null if it is not present.
             
                 The last table to add flows to and then wrap around
             
         
        Returns:
        Uint32 endTableId, or null if it is not present.
      • requireEndTableId

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireEndTableId()
        Return endTableId, guaranteed to be non-null.
             
                 The last table to add flows to and then wrap around
             
         
        Returns:
        Uint32 endTableId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if endTableId is not present
      • getBatchSize

        org.opendaylight.yangtools.yang.common.Uint32 getBatchSize()
        Return batchSize, or null if it is not present.
             
                 batch size
             
         
        Returns:
        Uint32 batchSize, or null if it is not present.
      • requireBatchSize

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireBatchSize()
        Return batchSize, guaranteed to be non-null.
             
                 batch size
             
         
        Returns:
        Uint32 batchSize, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if batchSize is not present
      • getSeq

        Boolean getSeq()
        Return seq, or null if it is not present.
             
                 Whether to use sequential or concurrent writer
             
         
        Returns:
        Boolean seq, or null if it is not present.
      • requireSeq

        default @NonNull Boolean requireSeq()
        Return seq, guaranteed to be non-null.
             
                 Whether to use sequential or concurrent writer
             
         
        Returns:
        Boolean seq, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if seq is not present
      • getTxChain

        Boolean getTxChain()
        Return txChain, or null if it is not present.
             
                 Whether to use PingPong Broker or not. seq is ignored.
             
         
        Returns:
        Boolean txChain, or null if it is not present.
      • requireTxChain

        default @NonNull Boolean requireTxChain()
        Return txChain, guaranteed to be non-null.
             
                 Whether to use PingPong Broker or not. seq is ignored.
             
         
        Returns:
        Boolean txChain, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if txChain is not present
      • getSleepFor

        org.opendaylight.yangtools.yang.common.Uint32 getSleepFor()
        Return sleepFor, or null if it is not present.
             
                 sleep for the given milliseconds
             
         
        Returns:
        Uint32 sleepFor, or null if it is not present.
      • requireSleepFor

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireSleepFor()
        Return sleepFor, guaranteed to be non-null.
             
                 sleep for the given milliseconds
             
         
        Returns:
        Uint32 sleepFor, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if sleepFor is not present
      • getSleepAfter

        org.opendaylight.yangtools.yang.common.Uint32 getSleepAfter()
        Return sleepAfter, or null if it is not present.
             
                 Sleep after the given number of iterations. Will be used in the concurrent case
                 only
             
         
        Returns:
        Uint32 sleepAfter, or null if it is not present.
      • requireSleepAfter

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireSleepAfter()
        Return sleepAfter, guaranteed to be non-null.
             
                 Sleep after the given number of iterations. Will be used in the concurrent case
                 only
             
         
        Returns:
        Uint32 sleepAfter, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if sleepAfter is not present