Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.messages.rev180813.messages.state

Interface Message

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.Augmentable<Message>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<MessagesState>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

@Generated("mdsal-binding-generator")
public interface Message
extends org.opendaylight.yangtools.yang.binding.ChildOf<MessagesState>, org.opendaylight.yangtools.yang.binding.Augmentable<Message>

Syslog messages the client is Subscribing to. This is all messages currently configured to be sent according to syslog-severity.

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

 container message {
   oc-ext:telemetry-atomic;
   config false;
   leaf msg {
     type string;
   }
   leaf priority {
     type uint8;
   }
   leaf app-name {
     type string;
   }
   leaf procid {
     type string;
   }
   leaf msgid {
     type string;
   }
 }
 

The schema path to identify an instance is openconfig-messagesmessages-statemessage

To create instances of this class use MessageBuilder.

See Also:

MessageBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static @NonNull org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method	Description
static boolean	bindingEquals(@NonNull Message thisObj, Object obj)	Default implementation of Object.equals(Object) contract for this interface.
static int	bindingHashCode(@NonNull Message obj)	Default implementation of Object.hashCode() contract for this interface.
static String	bindingToString(@NonNull Message obj)	Default implementation of Object.toString() contract for this interface.
String	getAppName()	Return appName, or null if it is not present.
String	getMsg()	Return msg, or null if it is not present.
String	getMsgid()	Return msgid, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint8	getPriority()	Return priority, or null if it is not present.
String	getProcid()	Return procid, or null if it is not present.
default Class<Message>	implementedInterface()
default @NonNull String	requireAppName()	Return appName, guaranteed to be non-null.
default @NonNull String	requireMsg()	Return msg, guaranteed to be non-null.
default @NonNull String	requireMsgid()	Return msgid, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint8	requirePriority()	Return priority, guaranteed to be non-null.
default @NonNull String	requireProcid()	Return procid, guaranteed to be non-null.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation, augmentations

Field Detail

QNAME

static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

Method Detail

implementedInterface

default Class<Message> 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 Message 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 Message 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 Message 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

getMsg

String getMsg()

Return msg, or null if it is not present.

     
         Message payload. If other leafs within this container not supported, this leaf
         MAY include the entire message, inclding pri, procid, app-name etc..
     
 

Returns:

String msg, or null if it is not present.

requireMsg

default @NonNull String requireMsg()

Return msg, guaranteed to be non-null.

     
         Message payload. If other leafs within this container not supported, this leaf
         MAY include the entire message, inclding pri, procid, app-name etc..
     
 

Returns:

String msg, guaranteed to be non-null.

Throws:

NoSuchElementException - if msg is not present

getPriority

org.opendaylight.yangtools.yang.common.Uint8 getPriority()

Return priority, or null if it is not present.

     
         The Priority value (PRIVAL) represents both the Facility and Severity.
     
 

Returns:

Uint8 priority, or null if it is not present.

requirePriority

default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requirePriority()

Return priority, guaranteed to be non-null.

     
         The Priority value (PRIVAL) represents both the Facility and Severity.
     
 

Returns:

Uint8 priority, guaranteed to be non-null.

Throws:

NoSuchElementException - if priority is not present

getAppName

String getAppName()

Return appName, or null if it is not present.

     
         The APP-NAME field SHOULD identify the device or application that originated the
         message.
     
 

Returns:

String appName, or null if it is not present.

requireAppName

default @NonNull String requireAppName()

Return appName, guaranteed to be non-null.

     
         The APP-NAME field SHOULD identify the device or application that originated the
         message.
     
 

Returns:

String appName, guaranteed to be non-null.

Throws:

NoSuchElementException - if appName is not present

getProcid

String getProcid()

Return procid, or null if it is not present.

     
         PROCID is a value that is included in the message, having no interoperable
         meaning, except that a change in the value indicates there has been a
         discontinuity in syslog reporting.
     
 

Returns:

String procid, or null if it is not present.

requireProcid

default @NonNull String requireProcid()

Return procid, guaranteed to be non-null.

     
         PROCID is a value that is included in the message, having no interoperable
         meaning, except that a change in the value indicates there has been a
         discontinuity in syslog reporting.
     
 

Returns:

String procid, guaranteed to be non-null.

Throws:

NoSuchElementException - if procid is not present

getMsgid

String getMsgid()

Return msgid, or null if it is not present.

     
         The MSGID SHOULD identify the type of message. For example, a firewall might use
         the MSGID 'TCPIN' for incoming TCP traffic and the MSGID 'TCPOUT' for outgoing
         TCP traffic.
     
 

Returns:

String msgid, or null if it is not present.

requireMsgid

default @NonNull String requireMsgid()

Return msgid, guaranteed to be non-null.

     
         The MSGID SHOULD identify the type of message. For example, a firewall might use
         the MSGID 'TCPIN' for incoming TCP traffic and the MSGID 'TCPOUT' for outgoing
         TCP traffic.
     
 

Returns:

String msgid, guaranteed to be non-null.

Throws:

NoSuchElementException - if msgid is not present