Module org.elasticsearch.server

Package org.elasticsearch.action.admin.indices.sampling

Class GetSampleConfigurationAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.LegacyActionRequest

org.elasticsearch.action.support.local.LocalClusterStateRequest

org.elasticsearch.action.admin.indices.sampling.GetSampleConfigurationAction.Request

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest, TransportRequest

Enclosing class:

GetSampleConfigurationAction

public static class GetSampleConfigurationAction.Request
extends LocalClusterStateRequest
implements IndicesRequest.Replaceable

Request object for getting the sampling configuration of a specific index.

This request specifies which index's sampling configuration should be retrieved. The index name must be provided and cannot be null or empty.

Nested Class Summary

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

IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcards

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

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

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
Request(StreamInput in)	Constructs a new request by deserializing from a StreamInput.
Request(TimeValue masterNodeTimeout)	Constructs a new request for the specified index.

Method Summary

Modifier and Type	Method	Description
Task	createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)	Returns the task object that should be used to keep track of the processing of the request.
boolean	equals(Object o)
String	getIndex()	Gets the index name for which to retrieve the sampling configuration.
int	hashCode()
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
String[]	indices()	Returns the array of indices that the action relates to
IndicesRequest	indices(String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
ActionRequestValidationException	validate()

Methods inherited from class org.elasticsearch.action.support.local.LocalClusterStateRequest

masterTimeout, writeTo

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable

allowsCrossProject, allowsRemoteIndices, getProjectRouting, getResolvedIndexExpressions, setResolvedIndexExpressions

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

Request

public Request(@Nullable
 TimeValue masterNodeTimeout)

Constructs a new request for the specified index.

Parameters:

masterNodeTimeout - the timeout for master node operations, or null for default

Request

public Request(StreamInput in)
        throws IOException

Constructs a new request by deserializing from a StreamInput.

Parameters:

in - the stream input to read from

Throws:

IOException - if an I/O error occurs during deserialization

Method Details

getIndex

public String getIndex()

Gets the index name for which to retrieve the sampling configuration.

Returns:

the index name

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

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(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()

Overrides:

validate in class LocalClusterStateRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

createTask

public Task createTask(long id,
 String type,
 String action,
 TaskId parentTaskId,
 Map<String,String> headers)

Description copied from interface: TaskAwareRequest

Returns the task object that should be used to keep track of the processing of the request.

Specified by:

createTask in interface TaskAwareRequest