Package org.opensearch.index.query

Class QueryValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

org.opensearch.common.ValidationException

org.opensearch.index.query.QueryValidationException

All Implemented Interfaces:

Serializable

public class QueryValidationException
extends org.opensearch.common.ValidationException

This exception can be used to indicate various reasons why validation of a query has failed.

See Also:

• Serialized Form

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
QueryValidationException()

Method Summary

Modifier and Type	Method	Description
static QueryValidationException	addValidationError(String queryId, String validationError, QueryValidationException validationException)	Helper method than can be used to add error messages to an existing QueryValidationException.
static QueryValidationException	addValidationErrors(List<String> validationErrors, QueryValidationException validationException)	Helper method than can be used to add error messages to an existing QueryValidationException.

Methods inherited from class org.opensearch.common.ValidationException

addValidationError, addValidationErrors, getMessage, validationErrors

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

QueryValidationException

public QueryValidationException()

Method Details

addValidationError

public static QueryValidationException addValidationError(String queryId,
 String validationError,
 QueryValidationException validationException)

Helper method than can be used to add error messages to an existing QueryValidationException. When passing null as the initial exception, a new exception is created.

Parameters:

queryId - the query that caused the error

validationError - the error message to add to an initial exception

validationException - an initial exception. Can be null, in which case a new exception is created.

Returns:

a QueryValidationException with added validation error message

addValidationErrors

public static QueryValidationException addValidationErrors(List<String> validationErrors,
 QueryValidationException validationException)

Helper method than can be used to add error messages to an existing QueryValidationException. When passing null as the initial exception, a new exception is created.

Parameters:

validationErrors - the error messages to add to an initial exception

validationException - an initial exception. Can be null, in which case a new exception is created.

Returns:

a QueryValidationException with added validation error message