Package co.elastic.clients.elasticsearch.indices

Class UpgradeRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.UpgradeRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class UpgradeRequest
extends RequestBase

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
UpgradeRequest(UpgradeRequest.Builder builder)
UpgradeRequest(java.util.function.Function<UpgradeRequest.Builder,UpgradeRequest.Builder> fn)

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<ExpandWildcardOptions>	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
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 Details

ENDPOINT

public static final Endpoint<UpgradeRequest,UpgradeResponse,ElasticsearchError> ENDPOINT

Endpoint "indices.upgrade".

Constructor Details

UpgradeRequest

public UpgradeRequest(UpgradeRequest.Builder builder)

UpgradeRequest

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

Method Details

index

@Nullable
public 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

allowNoIndices

@Nullable
public 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

@Nullable
public java.util.List<ExpandWildcardOptions> expandWildcards()

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

API name: expand_wildcards

ignoreUnavailable

@Nullable
public java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

waitForCompletion

@Nullable
public java.lang.Boolean waitForCompletion()

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

API name: wait_for_completion

onlyAncientSegments

@Nullable
public java.lang.Boolean onlyAncientSegments()

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

API name: only_ancient_segments