Package org.opensearch.client.opensearch.cat

Class ShardsRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.cat.ShardsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<ShardsRequest>

Enclosing class:

ShardsRequest

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

Builder for ShardsRequest.

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

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

API name: index

index

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

API name: index

addIndex

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

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

bytes

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

API name: bytes

build

public ShardsRequest build()

Builds a ShardsRequest.

Specified by:

build in interface ObjectBuilder<ShardsRequest>

Throws:

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