Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.action.user

Class QueryUserRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.xpack.core.security.action.user.QueryUserRequest

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

public final class QueryUserRequest
extends UntypedActionRequest

Request for the query Users API.
Model for API requests to the query users API

Nested Class Summary

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

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

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
QueryUserRequest()
QueryUserRequest(QueryBuilder queryBuilder)
QueryUserRequest(QueryBuilder queryBuilder, Integer from, Integer size, List<FieldSortBuilder> fieldSortBuilders, SearchAfterBuilder searchAfterBuilder, boolean withProfileUid)

Method Summary

Modifier and Type	Method	Description
List<FieldSortBuilder>	getFieldSortBuilders()
Integer	getFrom()
QueryBuilder	getQueryBuilder()
SearchAfterBuilder	getSearchAfterBuilder()
Integer	getSize()
boolean	isWithProfileUid()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

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

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, wait, wait, wait

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

Constructor Details

QueryUserRequest

public QueryUserRequest()

QueryUserRequest

public QueryUserRequest(QueryBuilder queryBuilder)

QueryUserRequest

public QueryUserRequest(@Nullable
 QueryBuilder queryBuilder,
 @Nullable
 Integer from,
 @Nullable
 Integer size,
 @Nullable
 List<FieldSortBuilder> fieldSortBuilders,
 @Nullable
 SearchAfterBuilder searchAfterBuilder,
 boolean withProfileUid)

Method Details

getQueryBuilder

public QueryBuilder getQueryBuilder()

getFrom

public Integer getFrom()

getSize

public Integer getSize()

getFieldSortBuilders

public List<FieldSortBuilder> getFieldSortBuilders()

getSearchAfterBuilder

public SearchAfterBuilder getSearchAfterBuilder()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

isWithProfileUid

public boolean isWithProfileUid()