Package org.opensearch.action.admin.indices.datastream

Class GetDataStreamAction.Request

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.master.MasterNodeRequest<Request>

org.opensearch.action.support.master.MasterNodeReadRequest<GetDataStreamAction.Request>

org.opensearch.action.admin.indices.datastream.GetDataStreamAction.Request

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, TaskAwareRequest

Enclosing class:

GetDataStreamAction

public static class GetDataStreamAction.Request
extends MasterNodeReadRequest<GetDataStreamAction.Request>
implements IndicesRequest.Replaceable

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.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.action.support.master.MasterNodeReadRequest

local

Fields inherited from class org.opensearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
Request(java.lang.String[] names)
Request(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
int	hashCode()
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 to
IndicesRequest	indices(java.lang.String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.action.support.master.MasterNodeReadRequest

local, local

Methods inherited from class org.opensearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

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.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

Request

public Request(java.lang.String[] names)

Request

public Request(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

writeTo

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

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeReadRequest<GetDataStreamAction.Request>

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

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

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

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

indices

public IndicesRequest 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