Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Interface BucketGrouping

All Superinterfaces:
ActionsGrouping, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
BucketsList
@Generated("mdsal-binding-generator") public interface BucketGrouping extends org.opendaylight.yangtools.yang.binding.DataObject, ActionsGrouping
Bucket for use in groups.

This class represents the following YANG schema fragment defined in module openflow-protocol 

 grouping bucket-grouping {
   leaf weight {
     type uint16;
   }
   leaf watch-port {
     type oft:port-number;
   }
   leaf watch-group {
     type uint32;
   }
   uses ofaction:actions-grouping;
 }

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opendaylight.yangtools.yang.common.Uint32
    getWatchGroup()
    Return watchGroup, or null if it is not present.
    PortNumber
    getWatchPort()
    Return watchPort, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getWeight()
    Return weight, or null if it is not present.
    Class<? extends BucketGrouping>
    implementedInterface()
     
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requireWatchGroup()
    Return watchGroup, guaranteed to be non-null.
    default @NonNull PortNumber
    requireWatchPort()
    Return watchPort, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireWeight()
    Return weight, guaranteed to be non-null.

    Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.ActionsGrouping

    getAction, nonnullAction

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

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

    • getWeight

      org.opendaylight.yangtools.yang.common.Uint16 getWeight()
      Return weight, or null if it is not present. 
           
         Relative weight of bucket. Only defined for select groups.
      Returns:
      Uint16 weight, or null if it is not present.

    • requireWeight

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireWeight()
      Return weight, guaranteed to be non-null. 
           
         Relative weight of bucket. Only defined for select groups.
      Returns:
      Uint16 weight, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if weight is not present

    • getWatchPort

      PortNumber getWatchPort()
      Return watchPort, or null if it is not present. 
           
         Port whose state affects whether this bucket is live. Only required for fast
         failover groups.
      Returns:
      PortNumber watchPort, or null if it is not present.

    • requireWatchPort

      default @NonNull PortNumber requireWatchPort()
      Return watchPort, guaranteed to be non-null. 
           
         Port whose state affects whether this bucket is live. Only required for fast
         failover groups.
      Returns:
      PortNumber watchPort, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if watchPort is not present

    • getWatchGroup

      org.opendaylight.yangtools.yang.common.Uint32 getWatchGroup()
      Return watchGroup, or null if it is not present. 
           
         Group whose state affects whether this bucket is live. Only required for fast
         failover groups.
      Returns:
      Uint32 watchGroup, or null if it is not present.

    • requireWatchGroup

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireWatchGroup()
      Return watchGroup, guaranteed to be non-null. 
           
         Group whose state affects whether this bucket is live. Only required for fast
         failover groups.
      Returns:
      Uint32 watchGroup, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if watchGroup is not present