org.elasticsearch.action.admin.indices.get

Class GetIndexRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.master.MasterNodeOperationRequest<T>

org.elasticsearch.action.support.master.MasterNodeReadOperationRequest<T>

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

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class GetIndexRequest
extends ClusterInfoRequest<GetIndexRequest>

A request to delete an index. Best created with Requests.deleteIndexRequest(String).

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.MasterNodeReadOperationRequest

local

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

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
GetIndexRequest()

Method Summary

Modifier and Type	Method and Description
GetIndexRequest	addFeatures(GetIndexRequest.Feature... features)
GetIndexRequest	addFeatures(String[] featureNames) Deprecated. use addFeatures(Feature[]) instead
String[]	features() Deprecated. use featuresAsEnums() instead
GetIndexRequest	features(GetIndexRequest.Feature... features)
GetIndexRequest	features(String[] featureNames) Deprecated. use features(Feature[]) instead
GetIndexRequest.Feature[]	featuresAsEnums()
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
GetIndexRequest	indicesOptions(IndicesOptions indicesOptions)
void	readFrom(StreamInput in)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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

indices, indices, types, types

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

local, local, readLocal, readLocal, writeLocal, writeLocal

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

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage

putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

GetIndexRequest

public GetIndexRequest()

Method Detail

features

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

features

@Deprecated
public GetIndexRequest features(String[] featureNames)

Deprecated. use features(Feature[]) instead

addFeatures

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

addFeatures

@Deprecated
public GetIndexRequest addFeatures(String[] featureNames)

Deprecated. use addFeatures(Feature[]) instead

features

@Deprecated
public String[] features()

Deprecated. use featuresAsEnums() instead

featuresAsEnums

public GetIndexRequest.Feature[] featuresAsEnums()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<GetIndexRequest>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ClusterInfoRequest<GetIndexRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ClusterInfoRequest<GetIndexRequest>

Throws:

IOException

indicesOptions

public GetIndexRequest indicesOptions(IndicesOptions indicesOptions)

Overrides:

indicesOptions in class ClusterInfoRequest<GetIndexRequest>

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

Overrides:

indicesOptions in class ClusterInfoRequest<GetIndexRequest>