Package org.elasticsearch.action.support.broadcast

Class BroadcastRequest<Request extends BroadcastRequest<Request>>

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Streamable, Writeable, TaskAwareRequest

Direct Known Subclasses:

ClearIndicesCacheRequest, FlushRequest, ForceMergeRequest, IndicesSegmentsRequest, IndicesStatsRequest, RecoveryRequest, RefreshRequest, SyncedFlushRequest, UpgradeRequest, UpgradeStatusRequest, ValidateQueryRequest

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

Nested Class Summary

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

IndicesRequest.Replaceable

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

TransportRequest.Empty

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
protected java.lang.String[]	indices

Constructor Summary

Constructors

Modifier	Constructor	Description
	BroadcastRequest()
protected	BroadcastRequest(java.lang.String[] indices)

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	indices()	Returns the array of indices that the action relates to
Request	indices(java.lang.String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
Request	indicesOptions(IndicesOptions indicesOptions)
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Field Detail

indices

protected java.lang.String[] indices

Constructor Detail

BroadcastRequest

public BroadcastRequest()

BroadcastRequest

protected BroadcastRequest(java.lang.String[] indices)

Method Detail

indices

public java.lang.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 Request indices(java.lang.String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

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 Request indicesOptions(IndicesOptions indicesOptions)

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest

Throws:

java.io.IOException