Module org.elasticsearch.xcore

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

Class TermsEnumRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.action.support.broadcast.BroadcastRequest<TermsEnumRequest>

org.elasticsearch.xpack.core.termsenum.action.TermsEnumRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.CrossProjectCandidate, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest, TransportRequest, ToXContent, ToXContentObject

public final class TermsEnumRequest
extends BroadcastRequest<TermsEnumRequest>
implements ToXContentObject

A request to gather terms for a given field matching a string prefix

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.CrossProjectCandidate, IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcards

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 IndicesOptions	DEFAULT_INDICES_OPTIONS
static final int	DEFAULT_SIZE
static final TimeValue	DEFAULT_TIMEOUT

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

indices

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
TermsEnumRequest()
TermsEnumRequest(String... indices)	Constructs a new term enum request against the provided indices.
TermsEnumRequest(StreamInput in)
TermsEnumRequest(TermsEnumRequest clone)

Method Summary

Modifier and Type	Method	Description
boolean	allowsCrossProject()
boolean	allowsRemoteIndices()
boolean	caseInsensitive()	If case insensitive matching is required
TermsEnumRequest	caseInsensitive(boolean caseInsensitive)	If case insensitive matching is required
boolean	equals(Object o)
String	field()	Indicates if detailed information about query is requested
TermsEnumRequest	field(String field)	The field to look inside for values
String	getProjectRouting()
ResolvedIndexExpressions	getResolvedIndexExpressions()
int	hashCode()
boolean	includeResolvedTo()
TermsEnumRequest	includeResolvedTo(boolean includeResolvedTo)
QueryBuilder	indexFilter()
TermsEnumRequest	indexFilter(QueryBuilder indexFilter)	Allows to filter shards if the provided QueryBuilder rewrites to `match_none`.
void	projectRouting(String projectRouting)
String	searchAfter()	The string after which to find matching field values (enables pagination of previous request)
TermsEnumRequest	searchAfter(String searchAfter)	The string after which to find matching field values (enables pagination of previous request)
void	setResolvedIndexExpressions(ResolvedIndexExpressions expressions)
int	size()	The number of terms to return
TermsEnumRequest	size(int size)	The number of terms to return
String	string()	The string required in matching field values
TermsEnumRequest	string(String string)	The string required in matching field values
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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

includeDataStreams, indices, indices, indicesOptions, indicesOptions, timeout, timeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.action.IndicesRequest.CrossProjectCandidate

getResolvedTargetProjects, setResolvedTargetProjects

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

DEFAULT_INDICES_OPTIONS

public static final IndicesOptions DEFAULT_INDICES_OPTIONS

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

• Constant Field Values

DEFAULT_TIMEOUT

public static final TimeValue DEFAULT_TIMEOUT

Constructor Details

TermsEnumRequest

public TermsEnumRequest()

TermsEnumRequest

public TermsEnumRequest(String... indices)

Constructs a new term enum request against the provided indices. No indices provided means it will run against all indices.

TermsEnumRequest

public TermsEnumRequest(TermsEnumRequest clone)

TermsEnumRequest

public TermsEnumRequest(StreamInput in)
                 throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BroadcastRequest<TermsEnumRequest>

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

allowsCrossProject

public boolean allowsCrossProject()

Specified by:

allowsCrossProject in interface IndicesRequest.CrossProjectCandidate

setResolvedIndexExpressions

public void setResolvedIndexExpressions(ResolvedIndexExpressions expressions)

Specified by:

setResolvedIndexExpressions in interface IndicesRequest.Replaceable

getResolvedIndexExpressions

@Nullable
public ResolvedIndexExpressions getResolvedIndexExpressions()

Specified by:

getResolvedIndexExpressions in interface IndicesRequest.Replaceable

projectRouting

public void projectRouting(@Nullable
 String projectRouting)

getProjectRouting

public String getProjectRouting()

Specified by:

getProjectRouting in interface IndicesRequest.CrossProjectCandidate

includeResolvedTo

public TermsEnumRequest includeResolvedTo(boolean includeResolvedTo)

includeResolvedTo

public boolean includeResolvedTo()

validate

public ActionRequestValidationException validate()

Overrides:

validate in class BroadcastRequest<TermsEnumRequest>

allowsRemoteIndices

public boolean allowsRemoteIndices()

Specified by:

allowsRemoteIndices in interface IndicesRequest.Replaceable

field

public TermsEnumRequest field(String field)

The field to look inside for values

field

public String field()

Indicates if detailed information about query is requested

string

public TermsEnumRequest string(String string)

The string required in matching field values

string

@Nullable
public String string()

The string required in matching field values

searchAfter

@Nullable
public String searchAfter()

The string after which to find matching field values (enables pagination of previous request)

searchAfter

public TermsEnumRequest searchAfter(String searchAfter)

The string after which to find matching field values (enables pagination of previous request)

size

public int size()

The number of terms to return

size

public TermsEnumRequest size(int size)

The number of terms to return

caseInsensitive

public TermsEnumRequest caseInsensitive(boolean caseInsensitive)

If case insensitive matching is required

caseInsensitive

public boolean caseInsensitive()

If case insensitive matching is required

indexFilter

public TermsEnumRequest indexFilter(QueryBuilder indexFilter)

Allows to filter shards if the provided QueryBuilder rewrites to `match_none`.

indexFilter

public QueryBuilder indexFilter()

toString

public String toString()

Overrides:

toString in class AbstractTransportRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object