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

Class ClusterIndicesShards

java.lang.Object

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

All Implemented Interfaces:

ToJsonp

public final class ClusterIndicesShards
extends java.lang.Object
implements ToJsonp

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClusterIndicesShards(ClusterIndicesShards.Builder builder)

Method Summary

Modifier and Type	Method	Description
ClusterIndicesShardsIndex	index()	Contains statistics about shards assigned to selected nodes.
java.lang.Number	primaries()	Number of primary shards assigned to selected nodes.
java.lang.Number	replication()	Ratio of replica shards to primary shards across all selected nodes.
protected static void	setupClusterIndicesShardsDeserializer(DelegatingDeserializer<ClusterIndicesShards.Builder> op)
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.lang.Number	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 Details

DESERIALIZER

public static final JsonpDeserializer<ClusterIndicesShards> DESERIALIZER

Json deserializer for ClusterIndicesShards

Constructor Details

ClusterIndicesShards

protected ClusterIndicesShards(ClusterIndicesShards.Builder builder)

Method Details

index

@Nullable public ClusterIndicesShardsIndex index()

Contains statistics about shards assigned to selected nodes. API name: index

primaries

@Nullable public java.lang.Number primaries()

Number of primary shards assigned to selected nodes. API name: primaries

replication

@Nullable public java.lang.Number replication()

Ratio of replica shards to primary shards across all selected nodes. API name: replication

total

@Nullable public java.lang.Number total()

Total number of shards assigned to selected nodes. API name: total

toJsonp

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

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

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

setupClusterIndicesShardsDeserializer

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