All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<NxActionMultipath>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<OfjNxActionMultipathGrouping>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

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

This class represents the following YANG schema fragment defined in module nicira-action

 container nx-action-multipath {
   leaf fields {
     type ofj-nx-hash-fields;
   }
   leaf basis {
     type uint16;
     default 0x400;
   }
   leaf algorithm {
     type ofj-nx-mp-algorithm;
   }
   leaf max-link {
     type uint16;
   }
   leaf arg {
     type uint32;
   }
   leaf ofs-nbits {
     type uint16;
   }
   leaf dst {
     type uint32;
   }
   leaf experimenter-id {
     type oft:experimenter-id;
   }
 }
 

To create instances of this class use NxActionMultipathBuilder.

See Also:
  • Field Summary

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

    Modifier and Type
    Method
    Description
    static boolean
    bindingEquals(@NonNull NxActionMultipath thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    Default implementation of Object.hashCode() contract for this interface.
    static String
    Default implementation of Object.toString() contract for this interface.
    Return algorithm, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    Return arg, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    Return basis, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    Return dst, or null if it is not present.
    Return experimenterId, or null if it is not present.
    Return fields, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    Return maxLink, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    Return ofsNbits, or null if it is not present.
     
    default @NonNull OfjNxMpAlgorithm
    Return algorithm, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    Return arg, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    Return basis, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    Return dst, guaranteed to be non-null.
    default @NonNull ExperimenterId
    Return experimenterId, guaranteed to be non-null.
    default @NonNull OfjNxHashFields
    Return fields, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    Return maxLink, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    Return ofsNbits, guaranteed to be non-null.

    Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

    augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations
  • 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

      default Class<NxActionMultipath> implementedInterface()
      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
    • bindingHashCode

      static int bindingHashCode(@NonNull NxActionMultipath 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 NxActionMultipath 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 NxActionMultipath 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
    • getFields

      OfjNxHashFields getFields()
      Return fields, or null if it is not present.
      Returns:
      OfjNxHashFields fields, or null if it is not present.
    • requireFields

      default @NonNull OfjNxHashFields requireFields()
      Return fields, guaranteed to be non-null.
      Returns:
      OfjNxHashFields fields, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if fields is not present
    • getBasis

      org.opendaylight.yangtools.yang.common.Uint16 getBasis()
      Return basis, or null if it is not present.
      Returns:
      Uint16 basis, or null if it is not present.
    • requireBasis

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireBasis()
      Return basis, guaranteed to be non-null.
      Returns:
      Uint16 basis, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if basis is not present
    • getAlgorithm

      OfjNxMpAlgorithm getAlgorithm()
      Return algorithm, or null if it is not present.
      Returns:
      OfjNxMpAlgorithm algorithm, or null if it is not present.
    • requireAlgorithm

      default @NonNull OfjNxMpAlgorithm requireAlgorithm()
      Return algorithm, guaranteed to be non-null.
      Returns:
      OfjNxMpAlgorithm algorithm, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if algorithm is not present
    • getMaxLink

      org.opendaylight.yangtools.yang.common.Uint16 getMaxLink()
      Return maxLink, or null if it is not present.
      Returns:
      Uint16 maxLink, or null if it is not present.
    • requireMaxLink

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireMaxLink()
      Return maxLink, guaranteed to be non-null.
      Returns:
      Uint16 maxLink, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if maxLink is not present
    • getArg

      org.opendaylight.yangtools.yang.common.Uint32 getArg()
      Return arg, or null if it is not present.
      Returns:
      Uint32 arg, or null if it is not present.
    • requireArg

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireArg()
      Return arg, guaranteed to be non-null.
      Returns:
      Uint32 arg, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if arg is not present
    • getOfsNbits

      org.opendaylight.yangtools.yang.common.Uint16 getOfsNbits()
      Return ofsNbits, or null if it is not present.
      Returns:
      Uint16 ofsNbits, or null if it is not present.
    • requireOfsNbits

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireOfsNbits()
      Return ofsNbits, guaranteed to be non-null.
      Returns:
      Uint16 ofsNbits, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if ofsNbits is not present
    • getDst

      org.opendaylight.yangtools.yang.common.Uint32 getDst()
      Return dst, or null if it is not present.
      Returns:
      Uint32 dst, or null if it is not present.
    • requireDst

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireDst()
      Return dst, guaranteed to be non-null.
      Returns:
      Uint32 dst, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if dst is not present
    • getExperimenterId

      ExperimenterId getExperimenterId()
      Return experimenterId, or null if it is not present.
      Returns:
      ExperimenterId experimenterId, or null if it is not present.
    • requireExperimenterId

      default @NonNull ExperimenterId requireExperimenterId()
      Return experimenterId, guaranteed to be non-null.
      Returns:
      ExperimenterId experimenterId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if experimenterId is not present