Module org.elasticsearch.server

Package org.elasticsearch.action.admin.indices.get

Class GetIndexRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

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

org.elasticsearch.action.support.master.MasterNodeReadRequest<Request>

org.elasticsearch.action.support.master.info.ClusterInfoRequest<GetIndexRequest>

org.elasticsearch.action.admin.indices.get.GetIndexRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest

public class GetIndexRequest
extends ClusterInfoRequest<GetIndexRequest>

A request to retrieve information about an index.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GetIndexRequest.Feature

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 inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest

local

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

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
GetIndexRequest()
GetIndexRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
GetIndexRequest	addFeatures(GetIndexRequest.Feature... features)
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.
GetIndexRequest.Feature[]	features()
GetIndexRequest	features(GetIndexRequest.Feature... features)
boolean	humanReadable()
GetIndexRequest	humanReadable(boolean humanReadable)
boolean	includeDefaults()	Whether to return all default settings for each of the indices.
GetIndexRequest	includeDefaults(boolean includeDefaults)	Sets the value of "include_defaults".
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.info.ClusterInfoRequest

includeDataStreams, indices, indices, indicesOptions, indicesOptions

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

local, local

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

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

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, hasReferences, 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.action.IndicesRequest.Replaceable

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

getDescription, setParentTask

Constructor Details

GetIndexRequest

public GetIndexRequest()

GetIndexRequest

public GetIndexRequest(StreamInput in)
                throws IOException

Throws:

IOException

Method Details

features

public GetIndexRequest features(GetIndexRequest.Feature... features)

addFeatures

public GetIndexRequest addFeatures(GetIndexRequest.Feature... features)

features

public GetIndexRequest.Feature[] features()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

humanReadable

public GetIndexRequest humanReadable(boolean humanReadable)

humanReadable

public boolean humanReadable()

includeDefaults

public GetIndexRequest includeDefaults(boolean includeDefaults)

Sets the value of "include_defaults".

Parameters:

includeDefaults - value of "include_defaults" to be set.

Returns:

this request

includeDefaults

public boolean includeDefaults()

Whether to return all default settings for each of the indices.

Returns:

true if defaults settings for each of the indices need to returned; false otherwise.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ClusterInfoRequest<GetIndexRequest>

Throws:

IOException

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.