Package co.elastic.clients.elasticsearch.cat

Class ShardsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<ShardsRequest.Builder>

co.elastic.clients.elasticsearch.cat.ShardsRequest.Builder

All Implemented Interfaces:

WithJson<ShardsRequest.Builder>, ObjectBuilder<ShardsRequest>

Enclosing class:

ShardsRequest

public static class ShardsRequest.Builder
extends CatRequestBase.AbstractBuilder<ShardsRequest.Builder>
implements ObjectBuilder<ShardsRequest>

Builder for ShardsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

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(List<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(String value,
 String... values)

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

API name: index

Adds one or more values to index.

self

protected ShardsRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<ShardsRequest.Builder>

build

public ShardsRequest build()

Builds a ShardsRequest.

Specified by:

build in interface ObjectBuilder<ShardsRequest>

Throws:

NullPointerException - if some of the required fields are null.