Package org.opensearch.client.opensearch.cluster.stats

Class ClusterIndicesShards

java.lang.Object

org.opensearch.client.opensearch.cluster.stats.ClusterIndicesShards

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ClusterIndicesShards
extends java.lang.Object
implements JsonpSerializable

Contains statistics about shards assigned to selected nodes.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
ClusterIndicesShardsIndex	index()	Contains statistics about shards assigned to selected nodes.
static ClusterIndicesShards	of(java.util.function.Function<ClusterIndicesShards.Builder,ObjectBuilder<ClusterIndicesShards>> fn)
java.lang.Double	primaries()	Number of primary shards assigned to selected nodes.
java.lang.Double	replication()	Ratio of replica shards to primary shards across all selected nodes.
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	setupClusterIndicesShardsDeserializer(ObjectDeserializer<ClusterIndicesShards.Builder> op)
java.lang.Double	total()	Total number of shards assigned to selected nodes.

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<ClusterIndicesShards> _DESERIALIZER

Json deserializer for ClusterIndicesShards

Method Detail

of

public static ClusterIndicesShards of(java.util.function.Function<ClusterIndicesShards.Builder,ObjectBuilder<ClusterIndicesShards>> fn)

index

@Nullable
public final ClusterIndicesShardsIndex index()

Contains statistics about shards assigned to selected nodes.

API name: index

primaries

@Nullable
public final java.lang.Double primaries()

Number of primary shards assigned to selected nodes.

API name: primaries

replication

@Nullable
public final java.lang.Double replication()

Ratio of replica shards to primary shards across all selected nodes.

API name: replication

total

@Nullable
public final java.lang.Double total()

Total number of shards assigned to selected nodes.

API name: total

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)

setupClusterIndicesShardsDeserializer

protected static void setupClusterIndicesShardsDeserializer(ObjectDeserializer<ClusterIndicesShards.Builder> op)