org.elasticsearch.action.admin.indices.upgrade.post

Class UpgradeRequest

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.broadcast.BroadcastRequest<UpgradeRequest>

org.elasticsearch.action.admin.indices.upgrade.post.UpgradeRequest

All Implemented Interfaces:

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

public class UpgradeRequest
extends BroadcastRequest<UpgradeRequest>

A request to upgrade one or more indices. In order to optimize on all the indices, pass an empty array or null for the indices.

See Also:

Requests.upgradeRequest(String...), IndicesAdminClient.upgrade(UpgradeRequest), UpgradeResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpgradeRequest.Defaults

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.broadcast.BroadcastRequest

indices

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
UpgradeRequest()
UpgradeRequest(String... indices) Constructs an optimization request over one or more indices.

Method Summary

Methods

Modifier and Type	Method and Description
void	readFrom(StreamInput in)
String	toString()
boolean	upgradeOnlyAncientSegments() Should the upgrade only the ancient (older major version of Lucene) segments? Defaults to false.
UpgradeRequest	upgradeOnlyAncientSegments(boolean upgradeOnlyAncientSegments) See upgradeOnlyAncientSegments()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest

indices, indices, indicesOptions, indicesOptions, validate

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradeRequest

public UpgradeRequest(String... indices)

Constructs an optimization request over one or more indices.

Parameters:

indices - The indices to optimize, no indices passed means all indices will be optimized.

UpgradeRequest

public UpgradeRequest()

Method Detail

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastRequest<UpgradeRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastRequest<UpgradeRequest>

Throws:

IOException

upgradeOnlyAncientSegments

public boolean upgradeOnlyAncientSegments()

Should the upgrade only the ancient (older major version of Lucene) segments? Defaults to false.

upgradeOnlyAncientSegments

public UpgradeRequest upgradeOnlyAncientSegments(boolean upgradeOnlyAncientSegments)

See upgradeOnlyAncientSegments()

toString

public String toString()

Overrides:

toString in class Object