Package org.opensearch.client.opensearch.cat

Class ShardsResponse

java.lang.Object

org.opensearch.client.opensearch.cat.ShardsResponse

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<ShardsResponse.Builder,ShardsResponse>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class ShardsResponse
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<ShardsResponse.Builder,ShardsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShardsResponse.Builder	Builder for ShardsResponse.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ShardsResponse>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
static ShardsResponse.Builder	builder()
protected static JsonpDeserializer<ShardsResponse>	createShardsResponseDeserializer()
static ShardsResponse	of(Function<ShardsResponse.Builder,ObjectBuilder<ShardsResponse>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
ShardsResponse.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final List<ShardsRecord>	valueBody()	Required - Response value.

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.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ShardsResponse> _DESERIALIZER

Method Details

of

public static ShardsResponse of(Function<ShardsResponse.Builder,ObjectBuilder<ShardsResponse>> fn)

valueBody

@Nonnull
public final List<ShardsRecord> valueBody()

Required - Response value.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public ShardsResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ShardsResponse.Builder,ShardsResponse>

Returns:

a new builder instance.

builder

@Nonnull
public static ShardsResponse.Builder builder()

createShardsResponseDeserializer

protected static JsonpDeserializer<ShardsResponse> createShardsResponseDeserializer()