Package org.opensearch.client.opensearch.cat

Class ShardsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cat.CatRequestBase.CatRequestBaseBuilder<ShardsRequest.Builder>

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

All Implemented Interfaces:

ObjectBuilder

Enclosing class:

ShardsRequest

public static class ShardsRequest.Builder
extends CatRequestBase.CatRequestBaseBuilder<ShardsRequest.Builder>

Builder for ShardsRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.CatRequestBaseBuilder

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardsRequest	build()	Builds a ShardsRequest.
ShardsRequest.Builder	bytes(Bytes value)	The unit in which to display byte values
ShardsRequest.Builder	index(java.lang.String value, java.lang.String... values)	A comma-separated list of index names to limit the returned information
ShardsRequest.Builder	index(java.util.List<java.lang.String> list)	A comma-separated list of index names to limit the returned information
protected ShardsRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.CatRequestBaseBuilder

headers, sort

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

bytes

public final ShardsRequest.Builder bytes(@Nullable
                                         Bytes value)

The unit in which to display byte values

API name: bytes

index

public final ShardsRequest.Builder index(java.util.List<java.lang.String> list)

A comma-separated list of index names to limit the returned information

API name: index

Adds all elements of list to index.

index

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

A comma-separated list of index names to limit the returned information

API name: index

Adds one or more values to index.

build

public ShardsRequest build()

Builds a ShardsRequest.

Throws:

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

self

protected ShardsRequest.Builder self()

Specified by:

self in class CatRequestBase.CatRequestBaseBuilder<ShardsRequest.Builder>