Package org.opensearch.client.opensearch.cat

Class IndicesRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.cat.IndicesRequest.Builder

All Implemented Interfaces:

ObjectBuilder<IndicesRequest>

Enclosing class:

IndicesRequest

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

Builder for IndicesRequest.

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
IndicesRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
IndicesRequest	build()	Builds a IndicesRequest.
IndicesRequest.Builder	bytes(jakarta.json.JsonValue value)	API name: bytes
IndicesRequest.Builder	expandWildcards(jakarta.json.JsonValue value)	API name: expand_wildcards
IndicesRequest.Builder	health(jakarta.json.JsonValue value)	API name: health
IndicesRequest.Builder	includeUnloadedSegments(java.lang.Boolean value)	API name: include_unloaded_segments
IndicesRequest.Builder	index(java.lang.String... value)	API name: index
IndicesRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
IndicesRequest.Builder	pri(java.lang.Boolean value)	API name: pri

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 IndicesRequest.Builder index(@Nullable java.util.List<java.lang.String> value)

API name: index

index

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

API name: index

addIndex

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

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

bytes

public IndicesRequest.Builder bytes(@Nullable jakarta.json.JsonValue value)

API name: bytes

expandWildcards

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

API name: expand_wildcards

health

public IndicesRequest.Builder health(@Nullable jakarta.json.JsonValue value)

API name: health

includeUnloadedSegments

public IndicesRequest.Builder includeUnloadedSegments(@Nullable java.lang.Boolean value)

API name: include_unloaded_segments

pri

public IndicesRequest.Builder pri(@Nullable java.lang.Boolean value)

API name: pri

build

public IndicesRequest build()

Builds a IndicesRequest.

Specified by:

build in interface ObjectBuilder<IndicesRequest>

Throws:

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