Package org.opensearch.client.opensearch.indices

Class UpgradeRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.UpgradeRequest

public class UpgradeRequest
extends RequestBase

DEPRECATED Upgrades to the current version of Lucene.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpgradeRequest.Builder	Builder for UpgradeRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<UpgradeRequest,UpgradeResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.upgrade".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
java.util.List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
java.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
java.lang.String	index()	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
static UpgradeRequest	of(java.util.function.Function<UpgradeRequest.Builder,ObjectBuilder<UpgradeRequest>> fn)
java.lang.Boolean	onlyAncientSegments()	If true, only ancient (an older Lucene major release) segments will be upgraded
java.lang.Boolean	waitForCompletion()	Specify whether the request should block until the all segments are upgraded (default: false)

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<UpgradeRequest,UpgradeResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.upgrade".

Method Detail

of

public static UpgradeRequest of(java.util.function.Function<UpgradeRequest.Builder,ObjectBuilder<UpgradeRequest>> fn)

allowNoIndices

@Nullable
public final java.lang.Boolean allowNoIndices()

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

expandWildcards

public final java.util.List<ExpandWildcard> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

@Nullable
public final java.lang.String index()

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

onlyAncientSegments

@Nullable
public final java.lang.Boolean onlyAncientSegments()

If true, only ancient (an older Lucene major release) segments will be upgraded

API name: only_ancient_segments

waitForCompletion

@Nullable
public final java.lang.Boolean waitForCompletion()

Specify whether the request should block until the all segments are upgraded (default: false)

API name: wait_for_completion