org.elasticsearch.action.suggest
Class SuggestRequest

java.lang.Object
  org.elasticsearch.action.support.broadcast.BroadcastOperationRequest
      org.elasticsearch.action.suggest.SuggestRequest

All Implemented Interfaces:

org.elasticsearch.action.ActionRequest, org.elasticsearch.common.io.stream.Streamable

public class SuggestRequest
extends org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

Field Summary

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

indices

Constructor Summary

SuggestRequest()

SuggestRequest(String... indices)

Method Summary

String	field()
void	field(String field)
SuggestRequest	indices(String... indices)
SuggestRequest	listenerThreaded(boolean threadedListener) Should the listener be called on a separate thread if needed.
SuggestRequest	operationThreading(org.elasticsearch.action.support.broadcast.BroadcastOperationThreading operationThreading) Controls the operation threading model.
void	readFrom(org.elasticsearch.common.io.stream.StreamInput in)
float	similarity()
void	similarity(float similarity)
int	size()
void	size(int size)
String	term()
void	term(String term)
String	toString()
SuggestRequest	types(String... types) The types of documents the query will run against.
org.elasticsearch.action.ActionRequestValidationException	validate()
void	writeTo(org.elasticsearch.common.io.stream.StreamOutput out)

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

beforeLocalFork, beforeStart, indices, listenerThreaded, operationThreading, operationThreading

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestRequest

public SuggestRequest()

SuggestRequest

public SuggestRequest(String... indices)

Method Detail

size

public int size()

size

public void size(int size)

field

public String field()

field

public void field(String field)

similarity

public float similarity()

similarity

public void similarity(float similarity)

term

public String term()

term

public void term(String term)

validate

public org.elasticsearch.action.ActionRequestValidationException validate()

Specified by:

validate in interface org.elasticsearch.action.ActionRequest

Overrides:

validate in class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

operationThreading

public SuggestRequest operationThreading(org.elasticsearch.action.support.broadcast.BroadcastOperationThreading operationThreading)

Controls the operation threading model.

Overrides:

operationThreading in class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

listenerThreaded

public SuggestRequest listenerThreaded(boolean threadedListener)

Should the listener be called on a separate thread if needed.

Specified by:

listenerThreaded in interface org.elasticsearch.action.ActionRequest

Overrides:

listenerThreaded in class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

indices

public SuggestRequest indices(String... indices)

Overrides:

indices in class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

types

public SuggestRequest types(String... types)

The types of documents the query will run against. Defaults to all types.

readFrom

public void readFrom(org.elasticsearch.common.io.stream.StreamInput in)
              throws IOException

Specified by:

readFrom in interface org.elasticsearch.common.io.stream.Streamable

Overrides:

readFrom in class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

Throws:

IOException

writeTo

public void writeTo(org.elasticsearch.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.elasticsearch.common.io.stream.Streamable

Overrides:

writeTo in class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object