Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class SearchContextMissingNodesException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.elasticsearch.ElasticsearchException

org.elasticsearch.action.search.SearchContextMissingNodesException

All Implemented Interfaces:

Serializable, Writeable, ToXContent, ToXContentFragment

public class SearchContextMissingNodesException
extends ElasticsearchException

Exception thrown when a search context references nodes that have left the cluster.

This exception indicates that a previously created search context is no longer valid because one or more of the nodes it depends on have left the cluster. This typically occurs when a client tries to fetch additional pages of search results after some nodes have become unavailable. The exception provides details about the missing nodes and the context that is no longer valid.

The exception is returned with HTTP status 404 (NOT_FOUND) when serialized to REST responses.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SearchContextMissingNodesException.ContextType	The type of search context that became invalid.

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final TransportVersion	SEARCH_CONTEXT_MISSING_NODES_EXCEPTION_VERSION	The transport version at which this exception type was introduced.

Fields inherited from class org.elasticsearch.ElasticsearchException

REST_EXCEPTION_SKIP_CAUSE, REST_EXCEPTION_SKIP_STACK_TRACE, REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT, STACK_TRACE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SearchContextMissingNodesException(SearchContextMissingNodesException.ContextType contextType, Set<String> missingNodeIds)	Constructs a new SearchContextMissingNodesException.
SearchContextMissingNodesException(StreamInput in)	Constructs a new SearchContextMissingNodesException from a StreamInput.

Method Summary

Modifier and Type	Method	Description
SearchContextMissingNodesException.ContextType	getContextType()	Returns the type of search context that is no longer valid.
Set<String>	getMissingNodeIds()	Returns the set of node IDs that have left the cluster.
protected void	metadataToXContent(XContentBuilder builder, ToXContent.Params params)	Serializes the exception metadata to XContent format.
RestStatus	status()	Returns the HTTP status code for this exception.
protected void	writeTo(StreamOutput out, Writeable.Writer<Throwable> nestedExceptionsWriter)	Serializes this exception to a StreamOutput.

Methods inherited from class org.elasticsearch.ElasticsearchException

addBodyHeader, addBodyHeader, addHttpHeader, addHttpHeader, addMetadata, addMetadata, failureFromXContent, fromXContent, generateFailureXContent, generateThrowableXContent, generateThrowableXContent, getBodyHeader, getBodyHeaderKeys, getBodyHeaders, getDetailedMessage, getExceptionName, getExceptionName, getHttpHeader, getHttpHeaderKeys, getHttpHeaders, getId, getIndex, getMetadata, getMetadata, getMetadataKeys, getResourceId, getResourceType, getRootCause, getShardId, guessRootCauses, guessRootCauses, innerFromXContent, innerToXContent, isRegistered, isTimeout, readException, readException, readStackTrace, setIndex, setIndex, setResources, setShard, toString, toXContent, toXContent, unwrapCause, writeException, writeStackTraces, writeTo

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

SEARCH_CONTEXT_MISSING_NODES_EXCEPTION_VERSION

public static final TransportVersion SEARCH_CONTEXT_MISSING_NODES_EXCEPTION_VERSION

The transport version at which this exception type was introduced.

Constructor Details

SearchContextMissingNodesException

public SearchContextMissingNodesException(SearchContextMissingNodesException.ContextType contextType,
 Set<String> missingNodeIds)

Constructs a new SearchContextMissingNodesException.

Parameters:

contextType - the type of search context

missingNodeIds - the set of node IDs that have left the cluster

SearchContextMissingNodesException

public SearchContextMissingNodesException(StreamInput in)
                                   throws IOException

Constructs a new SearchContextMissingNodesException from a StreamInput. Used for deserialization during transport communication between nodes.

Parameters:

in - the input stream to read from

Throws:

IOException - if an I/O error occurs while reading from the stream

Method Details

writeTo

protected void writeTo(StreamOutput out,
 Writeable.Writer<Throwable> nestedExceptionsWriter)
                throws IOException

Serializes this exception to a StreamOutput. Overrides the protected two-arg overload so that custom fields are written both on the direct Writeable.writeTo path and on the ElasticsearchException.writeException nesting path.

Overrides:

writeTo in class ElasticsearchException

Throws:

IOException

status

public RestStatus status()

Returns the HTTP status code for this exception.

Overrides:

status in class ElasticsearchException

Returns:

RestStatus.NOT_FOUND to indicate the search context is not found

metadataToXContent

protected void metadataToXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Serializes the exception metadata to XContent format. Adds context type and list of missing node IDs to the JSON output.

Overrides:

metadataToXContent in class ElasticsearchException

Parameters:

builder - the XContent builder to write to

params - additional parameters for serialization

Throws:

IOException - if an I/O error occurs while writing

getMissingNodeIds

public Set<String> getMissingNodeIds()

Returns the set of node IDs that have left the cluster.

Returns:

an immutable set of node IDs

getContextType

public SearchContextMissingNodesException.ContextType getContextType()

Returns the type of search context that is no longer valid.

Returns:

the context type