Package org.opensearch.client.opensearch.indices

Class SegmentsRequest.Builder

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<SegmentsRequest>

Enclosing class:

SegmentsRequest

public static class SegmentsRequest.Builder
extends java.lang.Object
implements ObjectBuilder<SegmentsRequest>

Builder for SegmentsRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SegmentsRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
SegmentsRequest.Builder	allowNoIndices(java.lang.Boolean value)	API name: allow_no_indices
SegmentsRequest	build()	Builds a SegmentsRequest.
SegmentsRequest.Builder	expandWildcards(jakarta.json.JsonValue value)	API name: expand_wildcards
SegmentsRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
SegmentsRequest.Builder	index(java.lang.String... value)	API name: index
SegmentsRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
SegmentsRequest.Builder	verbose(java.lang.Boolean value)	API name: verbose

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

index

public SegmentsRequest.Builder index(@Nullable java.util.List<java.lang.String> value)

API name: index

index

public SegmentsRequest.Builder index(java.lang.String... value)

API name: index

addIndex

public SegmentsRequest.Builder addIndex(java.lang.String value)

Add a value to index(List), creating the list if needed.

allowNoIndices

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

API name: allow_no_indices

expandWildcards

public SegmentsRequest.Builder expandWildcards(@Nullable jakarta.json.JsonValue value)

API name: expand_wildcards

ignoreUnavailable

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

API name: ignore_unavailable

verbose

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

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.