Apache REEF  0.16.0
Retainable Evaluator Execution Framework
Public Member Functions | Properties | List of all members
Org.Apache.REEF.Common.Api.IFailure Interface Reference

Common interface for all error messages in REEF. More...

Inherits Org.Apache.REEF.Utilities.IIdentifiable.

Inherited by Org.Apache.REEF.Common.Api.AbstractFailure, and Org.Apache.REEF.Common.Api.IAbstractFailure.

Public Member Functions

Exception AsError ()
 Return the original Java Exception, or generate a new one if it does not exists. More...
 

Properties

string Message [get, set]
 One-line error message. More...
 
Optional< string > Description [get, set]
 Optional long error description. More...
 
Optional< string > Reason [get, set]
 Exception that caused the error, or null. More...
 
Optional< byte[]> Data [get, set]
 Optional serialized version of the error message. More...
 
- Properties inherited from Org.Apache.REEF.Utilities.IIdentifiable
string Id [get]
 The Id of this object, e.g. More...
 

Detailed Description

Common interface for all error messages in REEF.

Most of its functionality is generic and implemented in the AbstractFailure class.

Member Function Documentation

◆ AsError()

Exception Org.Apache.REEF.Common.Api.IFailure.AsError ( )

Return the original Java Exception, or generate a new one if it does not exists.

ALWAYS returns an exception, never null

Implemented in Org.Apache.REEF.Common.Api.AbstractFailure.

Property Documentation

◆ Data

Optional<byte[]> Org.Apache.REEF.Common.Api.IFailure.Data
getset

Optional serialized version of the error message.

◆ Description

Optional<string> Org.Apache.REEF.Common.Api.IFailure.Description
getset

Optional long error description.

◆ Message

string Org.Apache.REEF.Common.Api.IFailure.Message
getset

One-line error message.

Should never be null.

◆ Reason

Optional<string> Org.Apache.REEF.Common.Api.IFailure.Reason
getset

Exception that caused the error, or null.


The documentation for this interface was generated from the following file: