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

Class UpgradeRequestBuilder

java.lang.Object

org.opensearch.action.ActionRequestBuilder<UpgradeRequest,UpgradeResponse>

org.opensearch.action.support.broadcast.BroadcastOperationRequestBuilder<UpgradeRequest,UpgradeResponse,UpgradeRequestBuilder>

org.opensearch.action.admin.indices.upgrade.post.UpgradeRequestBuilder

@PublicApi(since="1.0.0")
public class UpgradeRequestBuilder
extends BroadcastOperationRequestBuilder<UpgradeRequest,UpgradeResponse,UpgradeRequestBuilder>

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.

Opensearch.api:

Field Summary

Fields inherited from class org.opensearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
UpgradeRequestBuilder(OpenSearchClient client, UpgradeAction action)

Method Summary

Modifier and Type	Method	Description
UpgradeRequestBuilder	setUpgradeOnlyAncientSegments(boolean upgradeOnlyAncientSegments)	Should the upgrade only the ancient (older major version of Lucene) segments?

Methods inherited from class org.opensearch.action.support.broadcast.BroadcastOperationRequestBuilder

setIndices, setIndicesOptions

Methods inherited from class org.opensearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Details

UpgradeRequestBuilder

public UpgradeRequestBuilder(OpenSearchClient client,
 UpgradeAction action)

Method Details

setUpgradeOnlyAncientSegments

public UpgradeRequestBuilder setUpgradeOnlyAncientSegments(boolean upgradeOnlyAncientSegments)

Should the upgrade only the ancient (older major version of Lucene) segments?