org.elasticsearch.action.support.broadcast

Class BroadcastRequest<T extends BroadcastRequest>

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

ClearIndicesCacheRequest, CountRequest, DfsOnlyRequest, ExistsRequest, FieldStatsRequest, FlushRequest, ForceMergeRequest, IndicesSegmentsRequest, IndicesStatsRequest, PercolateRequest, RecoveryRequest, RefreshRequest, SuggestRequest, SyncedFlushRequest, UpgradeRequest, UpgradeStatusRequest, ValidateQueryRequest

public class BroadcastRequest<T extends BroadcastRequest>
extends ActionRequest<T>
implements IndicesRequest.Replaceable

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

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

IndicesRequest.Replaceable

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	indices

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Modifier	Constructor and Description
	BroadcastRequest()
protected	BroadcastRequest(ActionRequest originalRequest)
protected	BroadcastRequest(String[] indices)

Method Summary

Methods

Modifier and Type	Method and Description
String[]	indices() Returns the array of indices that the action relates to
T	indices(String... indices)
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
T	indicesOptions(IndicesOptions indicesOptions)
void	readFrom(StreamInput in)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Field Detail

indices

protected String[] indices

Constructor Detail

BroadcastRequest

public BroadcastRequest()

BroadcastRequest

protected BroadcastRequest(ActionRequest originalRequest)

BroadcastRequest

protected BroadcastRequest(String[] indices)

Method Detail

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indices

public final T indices(String... indices)

Specified by:

indices in interface IndicesRequest.Replaceable

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<T extends BroadcastRequest>

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

indicesOptions

public final T indicesOptions(IndicesOptions indicesOptions)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<T extends BroadcastRequest>

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<T extends BroadcastRequest>

Throws:

IOException