Package co.elastic.clients.elasticsearch.cluster.stats

Class StatsResponseBase

java.lang.Object

co.elastic.clients.elasticsearch.nodes.NodesResponseBase

co.elastic.clients.elasticsearch.cluster.stats.StatsResponseBase

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

ClusterStatsResponse

public abstract class StatsResponseBase
extends NodesResponseBase

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StatsResponseBase.AbstractBuilder<BuilderT extends StatsResponseBase.AbstractBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StatsResponseBase(StatsResponseBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
final CCSStats	ccs()	Required - Cross-cluster stats
final String	clusterName()	Required - Name of the cluster, based on the cluster name setting.
final String	clusterUuid()	Required - Unique identifier for the cluster.
final ClusterIndices	indices()	Required - Contains statistics about indices with shards assigned to selected nodes.
final ClusterNodes	nodes()	Required - Contains statistics about nodes selected by the request’s node filters.
final Map<String,Map<String,Long>>	repositories()	Required - Contains stats on repository feature usage exposed in cluster stats for telemetry.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends StatsResponseBase.AbstractBuilder<BuilderT>> void	setupStatsResponseBaseDeserializer(ObjectDeserializer<BuilderT> op)
final ClusterSnapshotStats	snapshots()	Required - Contains stats cluster snapshots.
final HealthStatus	status()	Health status of the cluster, based on the state of its primary and replica shards.
final long	timestamp()	Required - Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.

Methods inherited from class co.elastic.clients.elasticsearch.nodes.NodesResponseBase

nodeStats, serialize, setupNodesResponseBaseDeserializer, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

StatsResponseBase

protected StatsResponseBase(StatsResponseBase.AbstractBuilder<?> builder)

Method Details

clusterName

public final String clusterName()

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

API name: cluster_name

clusterUuid

public final 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

repositories

public final Map<String,Map<String,Long>> repositories()

Required - Contains stats on repository feature usage exposed in cluster stats for telemetry.

API name: repositories

snapshots

public final ClusterSnapshotStats snapshots()

Required - Contains stats cluster snapshots.

API name: snapshots

status

@Nullable
public final HealthStatus status()

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, for the last time the cluster statistics were refreshed.

API name: timestamp

ccs

public final CCSStats ccs()

Required - Cross-cluster stats

API name: ccs

serializeInternal

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

Overrides:

serializeInternal in class NodesResponseBase

setupStatsResponseBaseDeserializer

protected static <BuilderT extends StatsResponseBase.AbstractBuilder<BuilderT>>
void setupStatsResponseBaseDeserializer(ObjectDeserializer<BuilderT> op)