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

Class UpgradeRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.broadcast.BroadcastRequest<UpgradeRequest>

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest

public class UpgradeRequest
extends BroadcastRequest<UpgradeRequest>

A request to upgrade one or more indices. In order to update all 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	Description
static final 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

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

DEFAULT_INDICES_OPTIONS, indices

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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)	Write this into the StreamOutput.

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

includeDataStreams, indices, indices, indicesOptions, indicesOptions, timeout, timeout, validate

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

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

createTask, getDescription, setParentTask

Constructor Details

UpgradeRequest

public UpgradeRequest(String... indices)

Constructs an optimization request over one or more indices.

Parameters:

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

UpgradeRequest

public UpgradeRequest(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

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 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 TransportRequest