Package org.opensearch.action.support.broadcast

Class BroadcastRequest<Request extends BroadcastRequest<Request>>

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest

Direct Known Subclasses:

ClearIndicesCacheRequest, DataStreamsStatsAction.Request, FlushRequest, ForceMergeRequest, IndicesSegmentsRequest, IndicesStatsRequest, PitSegmentsRequest, RecoveryRequest, RefreshRequest, RemoteStoreStatsRequest, SegmentReplicationStatsRequest, UpgradeRequest, UpgradeStatusRequest, ValidateQueryRequest

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

Transport request for broadcast operations

Opensearch.internal:

Nested Class Summary

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

TransportRequest.Empty

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

IndicesRequest.Replaceable

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	indices

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BroadcastRequest(String... indices)
protected	BroadcastRequest(String[] indices, IndicesOptions indicesOptions)
	BroadcastRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
String[]	indices()	Returns the array of indices that the action relates to
final Request	indices(String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
final Request	indicesOptions(IndicesOptions indicesOptions)
org.opensearch.common.unit.TimeValue	timeout()
final Request	timeout(String timeout)
final Request	timeout(org.opensearch.common.unit.TimeValue timeout)
ActionRequestValidationException	validate()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Details

indices

protected String[] indices

Constructor Details

BroadcastRequest

public BroadcastRequest(org.opensearch.core.common.io.stream.StreamInput in)
                 throws IOException

Throws:

IOException

BroadcastRequest

protected BroadcastRequest(String... indices)

BroadcastRequest

protected BroadcastRequest(String[] indices,
 IndicesOptions indicesOptions)

Method Details

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

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

timeout

public org.opensearch.common.unit.TimeValue timeout()

timeout

public final Request timeout(org.opensearch.common.unit.TimeValue timeout)

timeout

public final Request timeout(String timeout)

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)

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.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 interface IndicesRequest

writeTo

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

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException