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

Interface Server

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Server>, 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.Identifiable<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.Identifiable<ServerKey>
    List of NTP servers to use for system clock synchronization. If '/system/ntp/enabled' is 'true', then the system will attempt to contact and utilize the specified NTP servers.

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

     list server {
   key address;
   leaf address {
     type leafref {
       path ../config/address;
     }
   }
   container config {
     uses system-ntp-server-config;
   }
   container state {
     config false;
     uses system-ntp-server-config;
     uses system-ntp-server-state;
   }
 }

    To create instances of this class use ServerBuilder.

    See Also:
    ServerBuilder, ServerKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<Server> implementedInterface()
        Specified by:
        implementedInterface in interface 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.Identifiable<ServerKey>

      • getAddress

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

      • requireAddress

        default @NonNull Host requireAddress()
        Return address, guaranteed to be non-null. 
             
         References the configured address or hostname of the NTP server.
        Returns:
        Host 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 an NTP server.
        Returns:
        Config config, or null if it is not present.

      • getState

        State getState()
        Return state, or null if it is not present. 
             
         Operational state data for an NTP server.
        Returns:
        State state, or null if it is not present.