Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes

Interface ControllerEntry

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<ControllerEntry>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<OvsdbBridgeAttributes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<ControllerEntryKey>
@Generated("mdsal-binding-generator") public interface ControllerEntry extends org.opendaylight.yangtools.yang.binding.ChildOf<OvsdbBridgeAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<ControllerEntry>, org.opendaylight.yangtools.yang.binding.Identifiable<ControllerEntryKey>
Bridge controller info

This class represents the following YANG schema fragment defined in module ovsdb 

 list controller-entry {
   key target;
   leaf target {
     type inet:uri;
   }
   leaf controller-uuid {
     type yang:uuid;
   }
   leaf is-connected {
     type boolean;
   }
   leaf max_backoff {
     type uint32 {
       range 1000..max;
     }
   }
   leaf inactivity_probe {
     type uint32;
   }
 }

To create instances of this class use ControllerEntryBuilder.

See Also:

  • 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 ControllerEntry thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull ControllerEntry obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull ControllerEntry obj)
    Default implementation of Object.toString() contract for this interface.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
    getControllerUuid()
    Return controllerUuid, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    getInactivityProbe()
    Return inactivityProbe, or null if it is not present.
    Boolean
    getIsConnected()
    Return isConnected, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    getMaxBackoff()
    Return maxBackoff, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
    getTarget()
    Return target, or null if it is not present.
    default Class<ControllerEntry>
    implementedInterface()
     
    ControllerEntryKey
    key()
     
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
    requireControllerUuid()
    Return controllerUuid, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requireInactivityProbe()
    Return inactivityProbe, guaranteed to be non-null.
    default @NonNull Boolean
    requireIsConnected()
    Return isConnected, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requireMaxBackoff()
    Return maxBackoff, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
    requireTarget()
    Return target, 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<ControllerEntry> 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 ControllerEntry 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 ControllerEntry 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 ControllerEntry 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

    • key

      ControllerEntryKey key()
      Specified by:
      key in interface org.opendaylight.yangtools.yang.binding.Identifiable<ControllerEntryKey>

    • getTarget

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTarget()
      Return target, or null if it is not present. 
           
         Uri telling bridge how to connect to controller
      Returns:
      Uri target, or null if it is not present.

    • requireTarget

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri requireTarget()
      Return target, guaranteed to be non-null. 
           
         Uri telling bridge how to connect to controller
      Returns:
      Uri target, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if target is not present

    • getControllerUuid

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getControllerUuid()
      Return controllerUuid, or null if it is not present. 
           
         The unique identifier of the controller
      Returns:
      Uuid controllerUuid, or null if it is not present.

    • requireControllerUuid

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireControllerUuid()
      Return controllerUuid, guaranteed to be non-null. 
           
         The unique identifier of the controller
      Returns:
      Uuid controllerUuid, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if controllerUuid is not present

    • getIsConnected

      Boolean getIsConnected()
      Return isConnected, or null if it is not present.
      Returns:
      Boolean isConnected, or null if it is not present.

    • requireIsConnected

      default @NonNull Boolean requireIsConnected()
      Return isConnected, guaranteed to be non-null.
      Returns:
      Boolean isConnected, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if isConnected is not present

    • getMaxBackoff

      org.opendaylight.yangtools.yang.common.Uint32 getMaxBackoff()
      Return maxBackoff, or null if it is not present. 
           
         Maximum number of milliseconds to wait between connection attempts
      Returns:
      Uint32 maxBackoff, or null if it is not present.

    • requireMaxBackoff

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireMaxBackoff()
      Return maxBackoff, guaranteed to be non-null. 
           
         Maximum number of milliseconds to wait between connection attempts
      Returns:
      Uint32 maxBackoff, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if maxBackoff is not present

    • getInactivityProbe

      org.opendaylight.yangtools.yang.common.Uint32 getInactivityProbe()
      Return inactivityProbe, or null if it is not present. 
           
         Maximum number of milliseconds of idle time on connection to controller before
         sending an inactivity probe message. A value of 0 disables inactivity probes.
      Returns:
      Uint32 inactivityProbe, or null if it is not present.

    • requireInactivityProbe

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireInactivityProbe()
      Return inactivityProbe, guaranteed to be non-null. 
           
         Maximum number of milliseconds of idle time on connection to controller before
         sending an inactivity probe message. A value of 0 disables inactivity probes.
      Returns:
      Uint32 inactivityProbe, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if inactivityProbe is not present