Package org.opensearch.ml.common.exception

Class MLException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.opensearch.ml.common.exception.MLException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ExecuteException, MLLimitExceededException, MLResourceNotFoundException, MLValidationException

public class MLException
extends RuntimeException

Base exception thrown from MLCommons.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MLException(String message)	Constructor with error message.
MLException(String message, Throwable cause)	Constructor with specified error message adn cause.
MLException(Throwable cause)	Constructor with specified cause.

Method Summary

Modifier and Type	Method	Description
MLException	countedInStats(boolean countInStats)	Set if the exception should be counted in stats.
boolean	isCountedInStats()	Returns if the exception should be counted in stats.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MLException

public MLException(String message)

Constructor with error message.

Parameters:

message - message of the exception

MLException

public MLException(Throwable cause)

Constructor with specified cause.

Parameters:

cause - exception cause

MLException

public MLException(String message,
 Throwable cause)

Constructor with specified error message adn cause.

Parameters:

message - error message

cause - exception cause

Method Details

isCountedInStats

public boolean isCountedInStats()

Returns if the exception should be counted in stats.

Returns:

true if should count the exception in stats; otherwise return false

countedInStats

public MLException countedInStats(boolean countInStats)

Set if the exception should be counted in stats.

Parameters:

countInStats - count the exception in stats

Returns:

the exception itself