Module org.elasticsearch.xcore
Class TermsEnumRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.broadcast.BroadcastRequest<TermsEnumRequest>
org.elasticsearch.xpack.core.termsenum.action.TermsEnumRequest
- All Implemented Interfaces:
IndicesRequest,IndicesRequest.Replaceable,Writeable,org.elasticsearch.core.RefCounted,TaskAwareRequest,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject
public final class TermsEnumRequest
extends BroadcastRequest<TermsEnumRequest>
implements org.elasticsearch.xcontent.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.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IndicesOptionsstatic intstatic org.elasticsearch.core.TimeValueFields inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest
indicesFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCEDFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionTermsEnumRequest(String... indices) Constructs a new term enum request against the provided indices.TermsEnumRequest(TermsEnumRequest clone) -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanIf case insensitive matching is requiredcaseInsensitive(boolean caseInsensitive) If case insensitive matching is requiredbooleanfield()Indicates if detailed information about query is requestedThe field to look inside for valuesinthashCode()indexFilter(QueryBuilder indexFilter) Allows to filter shards if the providedQueryBuilderrewrites to `match_none`.The string after which to find matching field values (enables pagination of previous request)searchAfter(String searchAfter) The string after which to find matching field values (enables pagination of previous request)intsize()The number of terms to returnsize(int size) The number of terms to returnstring()The string required in matching field valuesThe string required in matching field valuestoString()org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) validate()voidwriteTo(StreamOutput out) Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest
includeDataStreams, indices, indices, indicesOptions, indicesOptions, timeout, timeoutMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestIdMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTaskMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
DEFAULT_INDICES_OPTIONS
-
DEFAULT_SIZE
public static int DEFAULT_SIZE -
DEFAULT_TIMEOUT
public static org.elasticsearch.core.TimeValue DEFAULT_TIMEOUT
-
-
Constructor Details
-
TermsEnumRequest
public TermsEnumRequest() -
TermsEnumRequest
Constructs a new term enum request against the provided indices. No indices provided means it will run against all indices. -
TermsEnumRequest
-
TermsEnumRequest
- Throws:
IOException
-
-
Method Details
-
writeTo
- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classBroadcastRequest<TermsEnumRequest>- Throws:
IOException
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
validate
- Overrides:
validatein classBroadcastRequest<TermsEnumRequest>
-
allowsRemoteIndices
public boolean allowsRemoteIndices()- Specified by:
allowsRemoteIndicesin interfaceIndicesRequest.Replaceable
-
field
The field to look inside for values -
field
Indicates if detailed information about query is requested -
string
The string required in matching field values -
string
The string required in matching field values -
searchAfter
The string after which to find matching field values (enables pagination of previous request) -
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
The number of terms to return -
caseInsensitive
If case insensitive matching is required -
caseInsensitive
public boolean caseInsensitive()If case insensitive matching is required -
indexFilter
Allows to filter shards if the providedQueryBuilderrewrites to `match_none`. -
indexFilter
-
toString
- Overrides:
toStringin classTransportRequest
-
equals
-
hashCode
public int hashCode()
-