Package org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316.credentials

Interface Credentials

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Credentials>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Credentials>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface Credentials extends org.opendaylight.yangtools.yang.binding.ChildOf<Credentials>, org.opendaylight.yangtools.yang.binding.Augmentable<Credentials>

This class represents the following YANG schema fragment defined in module gnmi-topology 

 container credentials {
   leaf username {
     type string;
   }
   leaf password {
     type string;
   }
 }

To create instances of this class use CredentialsBuilder.

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<Credentials> 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 Credentials 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 Credentials 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 Credentials 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

    • getUsername

      String getUsername()
      Return username, or null if it is not present. 
           
         specify the target username as part of the user credentials.
      Returns:
      String username, or null if it is not present.

    • requireUsername

      default @NonNull String requireUsername()
      Return username, guaranteed to be non-null. 
           
         specify the target username as part of the user credentials.
      Returns:
      String username, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if username is not present

    • getPassword

      String getPassword()
      Return password, or null if it is not present. 
           
         specify the target password as part of the user credentials.
      Returns:
      String password, or null if it is not present.

    • requirePassword

      default @NonNull String requirePassword()
      Return password, guaranteed to be non-null. 
           
         specify the target password as part of the user credentials.
      Returns:
      String password, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if password is not present