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, Streamable, TaskAwareRequest

public class GetIndexRequest
extends ClusterInfoRequest<GetIndexRequest>

A request to retrieve information about an index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	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

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 and Description
GetIndexRequest()

Method Summary

Modifier and Type	Method and Description
GetIndexRequest	addFeatures(GetIndexRequest.Feature... features)
GetIndexRequest.Feature[]	features()
GetIndexRequest	features(GetIndexRequest.Feature... features)
boolean	humanReadable()
GetIndexRequest	humanReadable(boolean humanReadable)
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

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

indices, indices, indicesOptions, indicesOptions, types, types

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

Methods inherited from class org.elasticsearch.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.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Detail

GetIndexRequest

public GetIndexRequest()

Method Detail

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

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ClusterInfoRequest<GetIndexRequest>

Throws:

java.io.IOException

writeTo

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

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ClusterInfoRequest<GetIndexRequest>

Throws:

java.io.IOException