Package org.opensearch.client.opensearch.indices

Class UpgradeRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.UpgradeRequest.Builder

All Implemented Interfaces:

ObjectBuilder<UpgradeRequest>

Enclosing class:

UpgradeRequest

public static class UpgradeRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<UpgradeRequest>

Builder for UpgradeRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

allowNoIndices

public final UpgradeRequest.Builder allowNoIndices(@Nullable
                                                   java.lang.Boolean value)

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 UpgradeRequest.Builder expandWildcards(java.util.List<ExpandWildcard> list)

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

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

public final UpgradeRequest.Builder expandWildcards(ExpandWildcard value,
                                                    ExpandWildcard... values)

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

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreUnavailable

public final UpgradeRequest.Builder ignoreUnavailable(@Nullable
                                                      java.lang.Boolean value)

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

API name: ignore_unavailable

index

public final UpgradeRequest.Builder index(@Nullable
                                          java.lang.String value)

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

API name: index

onlyAncientSegments

public final UpgradeRequest.Builder onlyAncientSegments(@Nullable
                                                        java.lang.Boolean value)

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

API name: only_ancient_segments

waitForCompletion

public final UpgradeRequest.Builder waitForCompletion(@Nullable
                                                      java.lang.Boolean value)

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

API name: wait_for_completion

build

public UpgradeRequest build()

Builds a UpgradeRequest.

Specified by:

build in interface ObjectBuilder<UpgradeRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.