Package org.opensearch.client.opensearch.indices.segments

Class ShardsSegment

java.lang.Object

org.opensearch.client.opensearch.indices.segments.ShardsSegment

All Implemented Interfaces:

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

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

The segment information for a shard.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ShardsSegment>	_DESERIALIZER	Json deserializer for ShardsSegment

Method Summary

Modifier and Type	Method	Description
static ShardsSegment.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final int	numCommittedSegments()	Required - The number of committed segments.
final int	numSearchSegments()	Required - The number of segments available for search.
static ShardsSegment	of(Function<ShardsSegment.Builder,ObjectBuilder<ShardsSegment>> fn)
final ShardSegmentRouting	routing()	Required - API name: routing
final Map<String,Segment>	segments()	Required - The detailed information for each segment.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupShardsSegmentDeserializer(ObjectDeserializer<ShardsSegment.Builder> op)
ShardsSegment.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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<ShardsSegment> _DESERIALIZER

Json deserializer for ShardsSegment

Method Details

of

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

numCommittedSegments

public final int numCommittedSegments()

Required - The number of committed segments.

API name: num_committed_segments

numSearchSegments

public final int numSearchSegments()

Required - The number of segments available for search.

API name: num_search_segments

routing

@Nonnull
public final ShardSegmentRouting routing()

Required - API name: routing

segments

@Nonnull
public final Map<String,Segment> segments()

Required - The detailed information for each segment.

API name: segments

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public ShardsSegment.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<ShardsSegment.Builder,ShardsSegment>

Returns:

a new builder instance.

builder

@Nonnull
public static ShardsSegment.Builder builder()

setupShardsSegmentDeserializer

protected static void setupShardsSegmentDeserializer(ObjectDeserializer<ShardsSegment.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object