Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.dns.servers.top.servers

Interface Server

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Server>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Servers>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.KeyAware<ServerKey>
@Generated("mdsal-binding-generator") public interface Server extends org.opendaylight.yangtools.yang.binding.ChildOf<Servers>, org.opendaylight.yangtools.yang.binding.Augmentable<Server>, org.opendaylight.yangtools.yang.binding.KeyAware<ServerKey>
List of the DNS servers that the resolver should query. When the resolver is invoked by a calling application, it sends the query to the first name server this list. If no response has been received within 'timeout' seconds, the resolver continues with the next server in the list. If no response is received from any server, the resolver continues with the first server again. When the resolver has traversed the list 'attempts' times without receiving any it gives up and returns an error to the calling application. Implementations limit the number of entries in this list.

This class represents the following YANG schema fragment defined in module openconfig-system 

 list server {
   key address;
   ordered-by user;
   leaf address {
     type leafref {
       path ../config/address;
     }
   }
   container config {
     uses system-dns-servers-config;
   }
   container state {
     config false;
     uses system-dns-servers-config;
     uses system-dns-servers-state;
   }
 }

To create instances of this class use ServerBuilder.

See Also:

  • 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<Server> 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 Server 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 Server 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 Server 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

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

    • getAddress

      IpAddress getAddress()
      Return address, or null if it is not present. 
           
         References the configured address of the DNS server
      Returns:
      IpAddress address, or null if it is not present.

    • requireAddress

      default @NonNull IpAddress requireAddress()
      Return address, guaranteed to be non-null. 
           
         References the configured address of the DNS server
      Returns:
      IpAddress address, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if address is not present

    • getConfig

      Config getConfig()
      Return config, or null if it is not present. 
           
         Configuration data for each DNS resolver
      Returns:
      Config config, or null if it is not present.

    • nonnullConfig

      @NonNull Config nonnullConfig()
      Return config, or an empty instance if it is not present.
      Returns:
      Config config, or an empty instance if it is not present.

    • getState

      State getState()
      Return state, or null if it is not present. 
           
         Operational state data for each DNS resolver
      Returns:
      State state, or null if it is not present.

    • nonnullState

      @NonNull State nonnullState()
      Return state, or an empty instance if it is not present.
      Returns:
      State state, or an empty instance if it is not present.