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
,Writeable
,org.elasticsearch.common.util.concurrent.RefCounted
,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 class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.Replaceable
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 protected
BroadcastRequest(java.lang.String... indices)
protected
BroadcastRequest(java.lang.String[] indices, IndicesOptions indicesOptions)
protected
BroadcastRequest(java.lang.String[] indices, IndicesOptions indicesOptions, org.elasticsearch.common.unit.TimeValue timeout)
BroadcastRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description boolean
includeDataStreams()
Determines whether the request should be applied to data streams.java.lang.String[]
indices()
Returns the array of indices that the action relates toRequest
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)
org.elasticsearch.common.unit.TimeValue
timeout()
Request
timeout(org.elasticsearch.common.unit.TimeValue timeout)
ActionRequestValidationException
validate()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Field Details
-
indices
protected java.lang.String[] indices
-
-
Constructor Details
-
BroadcastRequest
- Throws:
java.io.IOException
-
BroadcastRequest
protected BroadcastRequest(java.lang.String... indices) -
BroadcastRequest
-
BroadcastRequest
protected BroadcastRequest(java.lang.String[] indices, IndicesOptions indicesOptions, @Nullable org.elasticsearch.common.unit.TimeValue timeout)
-
-
Method Details
-
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 interfaceIndicesRequest
-
indices
Description copied from interface:IndicesRequest.Replaceable
Sets the indices that the action relates to.- Specified by:
indices
in interfaceIndicesRequest.Replaceable
-
validate
- Specified by:
validate
in classActionRequest
-
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 interfaceIndicesRequest
-
indicesOptions
-
timeout
@Nullable public org.elasticsearch.common.unit.TimeValue timeout() -
timeout
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequest
Determines whether the request should be applied to data streams. Whenfalse
, none of the names or wildcard expressions inIndicesRequest.indices()
should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.- Specified by:
includeDataStreams
in interfaceIndicesRequest
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classActionRequest
- Throws:
java.io.IOException
-