Package org.opendaylight.yang.gen.v1.urn.opendaylight.node.ssl.connection.error.service.rev190723

Interface ErrorMessage

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
SslError
@Generated("mdsal-binding-generator") public interface ErrorMessage extends org.opendaylight.yangtools.yang.binding.DataObject
Error message structure.

This class represents the following YANG schema fragment defined in module node-ssl-connection-error 

 grouping error-message {
   leaf type {
     type ssl-error-type;
   }
   leaf code {
     type uint16;
   }
   leaf node-ip-address {
     type inet:ip-address;
   }
   leaf data {
     type string;
   }
 }

  • 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
    org.opendaylight.yangtools.yang.common.Uint16
    getCode()
    Return code, or null if it is not present.
    String
    getData()
    Return data, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
    getNodeIpAddress()
    Return nodeIpAddress, or null if it is not present.
    SslErrorType
    getType()
    Return type, or null if it is not present.
    Class<? extends ErrorMessage>
    implementedInterface()
     
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireCode()
    Return code, guaranteed to be non-null.
    default @NonNull String
    requireData()
    Return data, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
    requireNodeIpAddress()
    Return nodeIpAddress, guaranteed to be non-null.
    default @NonNull SslErrorType
    requireType()
    Return type, guaranteed to be non-null.

  • 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

      Class<? extends ErrorMessage> 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

    • getType

      SslErrorType getType()
      Return type, or null if it is not present.
      Returns:
      SslErrorType type, or null if it is not present.

    • requireType

      default @NonNull SslErrorType requireType()
      Return type, guaranteed to be non-null.
      Returns:
      SslErrorType type, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if type is not present

    • getCode

      org.opendaylight.yangtools.yang.common.Uint16 getCode()
      Return code, or null if it is not present. 
           
         Error code.
      Returns:
      Uint16 code, or null if it is not present.

    • requireCode

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireCode()
      Return code, guaranteed to be non-null. 
           
         Error code.
      Returns:
      Uint16 code, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if code is not present

    • getNodeIpAddress

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getNodeIpAddress()
      Return nodeIpAddress, or null if it is not present. 
           
         Connecting Node IP address.
      Returns:
      IpAddress nodeIpAddress, or null if it is not present.

    • requireNodeIpAddress

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireNodeIpAddress()
      Return nodeIpAddress, guaranteed to be non-null. 
           
         Connecting Node IP address.
      Returns:
      IpAddress nodeIpAddress, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if nodeIpAddress is not present

    • getData

      String getData()
      Return data, or null if it is not present. 
           
         Node SSL error cause.
      Returns:
      String data, or null if it is not present.

    • requireData

      default @NonNull String requireData()
      Return data, guaranteed to be non-null. 
           
         Node SSL error cause.
      Returns:
      String data, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if data is not present