Package org.opensearch.client.opensearch.indices

Class SegmentsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.SegmentsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<SegmentsRequest>

Enclosing class:

SegmentsRequest

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

Builder for SegmentsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SegmentsRequest.Builder	allowNoIndices(java.lang.Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
SegmentsRequest	build()	Builds a SegmentsRequest.
SegmentsRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
SegmentsRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
SegmentsRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
SegmentsRequest.Builder	index(java.lang.String value, java.lang.String... values)	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
SegmentsRequest.Builder	index(java.util.List<java.lang.String> list)	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
SegmentsRequest.Builder	verbose(java.lang.Boolean value)	Includes detailed memory usage by Lucene.

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

_checkSingleUse, _listAdd, _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 SegmentsRequest.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 SegmentsRequest.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 SegmentsRequest.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 SegmentsRequest.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 SegmentsRequest.Builder index(java.util.List<java.lang.String> list)

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

API name: index

Adds all elements of list to index.

index

public final SegmentsRequest.Builder index(java.lang.String value,
                                           java.lang.String... values)

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

API name: index

Adds one or more values to index.

verbose

public final SegmentsRequest.Builder verbose(@Nullable
                                             java.lang.Boolean value)

Includes detailed memory usage by Lucene.

API name: verbose

build

public SegmentsRequest build()

Builds a SegmentsRequest.

Specified by:

build in interface ObjectBuilder<SegmentsRequest>

Throws:

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