Package org.opensearch.client.opensearch.cat

Class ShardsResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cat.ShardsResponse.Builder

All Implemented Interfaces:

CopyableBuilder<ShardsResponse.Builder,ShardsResponse>, MutableBuilder<ShardsResponse.Builder,ShardsResponse>, ObjectBuilder<ShardsResponse>

Enclosing class:

ShardsResponse

public static class ShardsResponse.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ShardsResponse.Builder,ShardsResponse>

Builder for ShardsResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardsResponse	build()	Builds a ShardsResponse.
ShardsResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardsResponse.Builder	valueBody(Function<ShardsRecord.Builder,ObjectBuilder<ShardsRecord>> fn)	Required - Response value.
final ShardsResponse.Builder	valueBody(List<ShardsRecord> list)	Required - Response value.
final ShardsResponse.Builder	valueBody(ShardsRecord value, ShardsRecord... values)	Required - Response value.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ShardsResponse.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ShardsResponse.Builder,ShardsResponse>

Returns:

a new builder instance.

valueBody

@Nonnull
public final ShardsResponse.Builder valueBody(List<ShardsRecord> list)

Required - Response value.

Adds all elements of list to valueBody.

valueBody

@Nonnull
public final ShardsResponse.Builder valueBody(ShardsRecord value,
 ShardsRecord... values)

Required - Response value.

Adds one or more values to valueBody.

valueBody

@Nonnull
public final ShardsResponse.Builder valueBody(Function<ShardsRecord.Builder,ObjectBuilder<ShardsRecord>> fn)

Required - Response value.

Adds a value to valueBody using a builder lambda.

build

@Nonnull
public ShardsResponse build()

Builds a ShardsResponse.

Specified by:

build in interface ObjectBuilder<ShardsResponse>

Throws:

NullPointerException - if some of the required fields are null.