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

Class ClusterIndicesShards

java.lang.Object

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

All Implemented Interfaces:

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

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

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 final JsonpDeserializer<ClusterIndicesShards>	_DESERIALIZER	Json deserializer for ClusterIndicesShards

Method Summary

Modifier and Type	Method	Description
static ClusterIndicesShards.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final ClusterIndicesShardsIndex	index()	API name: index
static ClusterIndicesShards	of(Function<ClusterIndicesShards.Builder,ObjectBuilder<ClusterIndicesShards>> fn)
final Integer	primaries()	Number of primary shards assigned to selected nodes.
final Integer	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)
ClusterIndicesShards.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Integer	total()	Total number of shards assigned to selected nodes.

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<ClusterIndicesShards> _DESERIALIZER

Json deserializer for ClusterIndicesShards

Method Details

of

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

index

@Nullable
public final ClusterIndicesShardsIndex index()

API name: index

primaries

@Nullable
public final Integer primaries()

Number of primary shards assigned to selected nodes.

API name: primaries

replication

@Nullable
public final Integer replication()

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

API name: replication

total

@Nullable
public final Integer 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)

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static ClusterIndicesShards.Builder builder()

setupClusterIndicesShardsDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object