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

Class ClusterShardMetrics

java.lang.Object

org.opensearch.client.opensearch.cluster.stats.ClusterShardMetrics

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final double	avg()	Required - Mean number of shards in an index, counting only shards assigned to selected nodes.
static ClusterShardMetrics.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final double	max()	Required - Maximum number of shards in an index, counting only shards assigned to selected nodes.
final double	min()	Required - Minimum number of shards in an index, counting only shards assigned to selected nodes.
static ClusterShardMetrics	of(Function<ClusterShardMetrics.Builder,ObjectBuilder<ClusterShardMetrics>> fn)
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	setupClusterShardMetricsDeserializer(ObjectDeserializer<ClusterShardMetrics.Builder> op)
ClusterShardMetrics.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<ClusterShardMetrics> _DESERIALIZER

Json deserializer for ClusterShardMetrics

Method Details

of

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

avg

public final double avg()

Required - Mean number of shards in an index, counting only shards assigned to selected nodes.

API name: avg

max

public final double max()

Required - Maximum number of shards in an index, counting only shards assigned to selected nodes.

API name: max

min

public final double min()

Required - Minimum number of shards in an index, counting only shards assigned to selected nodes.

API name: min

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 ClusterShardMetrics.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<ClusterShardMetrics.Builder,ClusterShardMetrics>

Returns:

a new builder instance.

builder

@Nonnull
public static ClusterShardMetrics.Builder builder()

setupClusterShardMetricsDeserializer

protected static void setupClusterShardMetricsDeserializer(ObjectDeserializer<ClusterShardMetrics.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object