Package org.opendaylight.yang.gen.v1.urn.opendaylight.echo.service.rev150305

Interface SendEchoInput

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<SendEchoInput>, 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, NodeContextRef, org.opendaylight.yangtools.yang.binding.RpcInput
@Generated("mdsal-binding-generator") public interface SendEchoInput extends org.opendaylight.yangtools.yang.binding.RpcInput, org.opendaylight.yangtools.yang.binding.Augmentable<SendEchoInput>, NodeContextRef

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

 input input {
   uses inv:node-context-ref;
   leaf data {
     type binary;
   }
 }

  • 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
    static boolean
    bindingEquals(@NonNull SendEchoInput thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull SendEchoInput obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull SendEchoInput obj)
    Default implementation of Object.toString() contract for this interface.
    byte[]
    getData()
    Return data, or null if it is not present.
    default Class<SendEchoInput>
    implementedInterface()
     
    default byte @NonNull []
    requireData()
    Return data, guaranteed to be non-null.

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

    augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

    Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef

    getNode, requireNode

  • 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<SendEchoInput> 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
      Specified by:
      implementedInterface in interface NodeContextRef
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.RpcInput

    • bindingHashCode

      static int bindingHashCode(@NonNull SendEchoInput 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 SendEchoInput 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 SendEchoInput 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

    • getData

      byte[] getData()
      Return data, or null if it is not present. 
           
         Openflow echo request payload (arbirary-length data field). The data field might
         be a message timestamp to check latency, various lengths to measure bandwidth,
         or zero-size to verify liveness between the switch and controller.
      Returns:
      byte[] data, or null if it is not present.

    • requireData

      default byte @NonNull [] requireData()
      Return data, guaranteed to be non-null. 
           
         Openflow echo request payload (arbirary-length data field). The data field might
         be a message timestamp to check latency, various lengths to measure bandwidth,
         or zero-size to verify liveness between the switch and controller.
      Returns:
      byte[] data, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if data is not present