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

@JsonpDeserializable
public class ClusterStatsResponse
extends NodesResponseBase

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	clusterName()	Required - Name of the cluster, based on the Cluster name setting setting.
java.lang.String	clusterUuid()	Required - Unique identifier for the cluster.
ClusterIndices	indices()	Required - Contains statistics about indices with shards assigned to selected nodes.
ClusterNodes	nodes()	Required - Contains statistics about nodes selected by the request's node filters.
static ClusterStatsResponse	of(java.util.function.Function<ClusterStatsResponse.Builder,ObjectBuilder<ClusterStatsResponse>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupClusterStatsResponseDeserializer(ObjectDeserializer<ClusterStatsResponse.Builder> op)
HealthStatus	status()	Required - Health status of the cluster, based on the state of its primary and replica shards.
long	timestamp()	Required - Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed.

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

nodeStats, serialize, setupNodesResponseBaseDeserializer

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

Json deserializer for ClusterStatsResponse

Method Detail

of

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

clusterName

public final java.lang.String clusterName()

Required - Name of the cluster, based on the Cluster name setting setting.

API name: cluster_name

clusterUuid

public final java.lang.String clusterUuid()

Required - Unique identifier for the cluster.

API name: cluster_uuid

indices

public final ClusterIndices indices()

Required - Contains statistics about indices with shards assigned to selected nodes.

API name: indices

nodes

public final ClusterNodes nodes()

Required - Contains statistics about nodes selected by the request's node filters.

API name: nodes

status

public final HealthStatus status()

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

API name: status

timestamp

public final long timestamp()

Required - Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed.

API name: timestamp

serializeInternal

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

Overrides:

serializeInternal in class NodesResponseBase

setupClusterStatsResponseDeserializer

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