Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.errors.rev131116

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:

NodeErrorNotification

@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 flow-errors

 grouping error-message {
   leaf type {
     type error-type;
   }
   leaf code {
     type uint16;
   }
   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.
ErrorType	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 ErrorType	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

ErrorType getType()

Return type, or null if it is not present.

Returns:

ErrorType type, or null if it is not present.

requireType

default @NonNull ErrorType requireType()

Return type, guaranteed to be non-null.

Returns:

ErrorType 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.

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.

Returns:

Uint16 code, guaranteed to be non-null.

Throws:

NoSuchElementException - if code is not present

getData

String getData()

Return data, or null if it is not present.

Returns:

String data, or null if it is not present.

requireData

default @NonNull String requireData()

Return data, guaranteed to be non-null.

Returns:

String data, guaranteed to be non-null.

Throws:

NoSuchElementException - if data is not present