Package org.opensearch.client.opensearch.cluster

Class ClusterStatsResponse

java.lang.Object

org.opensearch.client.opensearch.nodes.NodesResponseBase

org.opensearch.client.opensearch.cluster.ClusterStatsResponse

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.nodes.NodesResponseBase

NodesResponseBase.AbstractBuilder<BuilderT extends NodesResponseBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ClusterStatsResponse.Builder	builder()
final String	clusterName()	Required - The name of the cluster.
final String	clusterUuid()	Required - The unique identifier of the cluster.
boolean	equals(Object o)
int	hashCode()
final ClusterIndices	indices()	Displays statistics about indexes in the cluster.
final ClusterNodes	nodes()	Displays statistics about nodes selected by the request's node filters.
static ClusterStatsResponse	of(Function<ClusterStatsResponse.Builder,ObjectBuilder<ClusterStatsResponse>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupClusterStatsResponseDeserializer(ObjectDeserializer<ClusterStatsResponse.Builder> op)
final HealthStatus	status()	Required - The health status of the cluster, based on the state of its primary and replica shards.
final long	timestamp()	Required - The Unix timestamp, in milliseconds, indicating when any cluster statistics were last refreshed.
ClusterStatsResponse.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch.nodes.NodesResponseBase

nodeStats, serialize, setupNodesResponseBaseDeserializer

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

Json deserializer for ClusterStatsResponse

Method Details

of

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

clusterName

@Nonnull
public final String clusterName()

Required - The name of the cluster.

API name: cluster_name

clusterUuid

@Nonnull
public final String clusterUuid()

Required - The unique identifier of the cluster.

API name: cluster_uuid

indices

@Nullable
public final ClusterIndices indices()

Displays statistics about indexes in the cluster.

API name: indices

nodes

@Nullable
public final ClusterNodes nodes()

Displays statistics about nodes selected by the request's node filters.

API name: nodes

status

@Nonnull
public final HealthStatus status()

Required - The health status of the cluster, based on the state of its primary and replica shards.

API name: status

timestamp

public final long timestamp()

Required - The Unix timestamp, in milliseconds, indicating when any cluster statistics were last refreshed.

API name: timestamp

serializeInternal

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

Overrides:

serializeInternal in class NodesResponseBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static ClusterStatsResponse.Builder builder()

setupClusterStatsResponseDeserializer

protected static void setupClusterStatsResponseDeserializer(ObjectDeserializer<ClusterStatsResponse.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class NodesResponseBase

equals

public boolean equals(Object o)

Overrides:

equals in class NodesResponseBase