Package org.opensearch.client.opensearch.cluster

Class StatsResponse

java.lang.Object

org.opensearch.client.opensearch.nodes.NodesResponseBase

org.opensearch.client.opensearch.cluster.StatsResponse

All Implemented Interfaces:

ToJsonp

public final class StatsResponse
extends NodesResponseBase

Nested Class Summary

Nested Classes

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

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<StatsResponse>	DESERIALIZER	Json deserializer for StatsResponse

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StatsResponse(StatsResponse.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.String	clusterName()	Name of the cluster, based on the Cluster name setting setting.
java.lang.String	clusterUuid()	Unique identifier for the cluster.
ClusterIndices	indices()	Contains statistics about indices with shards assigned to selected nodes.
ClusterNodes	nodes()	Contains statistics about nodes selected by the request's node filters.
protected static void	setupStatsResponseDeserializer(DelegatingDeserializer<StatsResponse.Builder> op)
jakarta.json.JsonValue	status()	Health status of the cluster, based on the state of its primary and replica shards.
java.lang.Number	timestamp()	Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

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

nodeStats, setupNodesResponseBaseDeserializer, toJsonp

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<StatsResponse> DESERIALIZER

Json deserializer for StatsResponse

Constructor Details

StatsResponse

protected StatsResponse(StatsResponse.Builder builder)

Method Details

clusterName

public java.lang.String clusterName()

Name of the cluster, based on the Cluster name setting setting. API name: cluster_name

clusterUuid

public java.lang.String clusterUuid()

Unique identifier for the cluster. API name: cluster_uuid

indices

public ClusterIndices indices()

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

nodes

public ClusterNodes nodes()

Contains statistics about nodes selected by the request's node filters. API name: nodes

status

public jakarta.json.JsonValue status()

Health status of the cluster, based on the state of its primary and replica shards. API name: status

timestamp

public java.lang.Number timestamp()

Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed. API name: timestamp

toJsonpInternal

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

Overrides:

toJsonpInternal in class NodesResponseBase

setupStatsResponseDeserializer

protected static void setupStatsResponseDeserializer(DelegatingDeserializer<StatsResponse.Builder> op)