Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.ntp.auth.keys.top.ntp.keys

Interface NtpKey

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<NtpKey>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<NtpKeys>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<NtpKeyKey>
@Generated("mdsal-binding-generator") public interface NtpKey extends org.opendaylight.yangtools.yang.binding.ChildOf<NtpKeys>, org.opendaylight.yangtools.yang.binding.Augmentable<NtpKey>, org.opendaylight.yangtools.yang.binding.Identifiable<NtpKeyKey>
List of NTP authentication keys

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

 list ntp-key {
   key key-id;
   leaf key-id {
     type leafref {
       path ../config/key-id;
     }
   }
   container config {
     uses system-ntp-auth-keys-config;
   }
   container state {
     config false;
     uses system-ntp-auth-keys-config;
     uses system-ntp-auth-keys-state;
   }
 }

To create instances of this class use NtpKeyBuilder.

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 NtpKey thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull NtpKey obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull NtpKey obj)
    Default implementation of Object.toString() contract for this interface.
    Config
    getConfig()
    Return config, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getKeyId()
    Return keyId, or null if it is not present.
    State
    getState()
    Return state, or null if it is not present.
    default Class<NtpKey>
    implementedInterface()
     
    NtpKeyKey
    key()
     
    @NonNull Config
    nonnullConfig()
    Return config, or an empty instance if it is not present.
    @NonNull State
    nonnullState()
    Return state, or an empty instance if it is not present.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireKeyId()
    Return keyId, 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<NtpKey> 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 NtpKey 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 NtpKey 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 NtpKey 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

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

    • getKeyId

      org.opendaylight.yangtools.yang.common.Uint16 getKeyId()
      Return keyId, or null if it is not present. 
           
         Reference to auth key-id list key
      Returns:
      Uint16 keyId, or null if it is not present.

    • requireKeyId

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireKeyId()
      Return keyId, guaranteed to be non-null. 
           
         Reference to auth key-id list key
      Returns:
      Uint16 keyId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if keyId is not present

    • getConfig

      Config getConfig()
      Return config, or null if it is not present. 
           
         Configuration data for NTP auth keys
      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 NTP auth keys
      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.