Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.termsenum.action

Class TermsEnumResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.broadcast.BaseBroadcastResponse

org.elasticsearch.action.support.broadcast.BroadcastResponse

org.elasticsearch.xpack.core.termsenum.action.TermsEnumResponse

All Implemented Interfaces:

Writeable, RefCounted, ToXContent, ToXContentObject

public class TermsEnumResponse
extends BroadcastResponse

The response of the _terms_enum action.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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 String	COMPLETE_FIELD
static final String	TERMS_FIELD

Fields inherited from class org.elasticsearch.action.support.broadcast.BaseBroadcastResponse

EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TermsEnumResponse(List<String> terms, int totalShards, int successfulShards, int failedShards, List<DefaultShardOperationFailedException> shardFailures, boolean complete)
TermsEnumResponse(List<String> terms, int totalShards, int successfulShards, int failedShards, List<DefaultShardOperationFailedException> shardFailures, boolean complete, ResolvedIndexExpressions resolvedLocally)

Method Summary

Modifier and Type	Method	Description
protected void	addCustomXContentFields(XContentBuilder builder, ToXContent.Params params)
ResolvedIndexExpressions	getResolvedLocally()	Returns the resolved index expressions from this project, or null if not requested.
List<String>	getTerms()	The list of terms.
boolean	isComplete()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastResponse

toXContent

Methods inherited from class org.elasticsearch.action.support.broadcast.BaseBroadcastResponse

getFailedShards, getShardFailures, getStatus, getSuccessfulShards, getTotalShards, getUnavailableShards

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

TERMS_FIELD

public static final String TERMS_FIELD

See Also:

• Constant Field Values

COMPLETE_FIELD

public static final String COMPLETE_FIELD

See Also:

• Constant Field Values

Constructor Details

TermsEnumResponse

public TermsEnumResponse(List<String> terms,
 int totalShards,
 int successfulShards,
 int failedShards,
 List<DefaultShardOperationFailedException> shardFailures,
 boolean complete)

TermsEnumResponse

public TermsEnumResponse(List<String> terms,
 int totalShards,
 int successfulShards,
 int failedShards,
 List<DefaultShardOperationFailedException> shardFailures,
 boolean complete,
 @Nullable
 ResolvedIndexExpressions resolvedLocally)

Method Details

getTerms

public List<String> getTerms()

The list of terms.

isComplete

public boolean isComplete()

getResolvedLocally

@Nullable
public ResolvedIndexExpressions getResolvedLocally()

Returns the resolved index expressions from this project, or null if not requested. Used by the coordinating project during cross-project search to validate index resolution.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BaseBroadcastResponse

Throws:

IOException

addCustomXContentFields

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

Overrides:

addCustomXContentFields in class BroadcastResponse

Throws:

IOException