Package org.opensearch.client.opensearch.cluster

Class StatsResponse.Builder

java.lang.Object

org.opensearch.client.opensearch.nodes.NodesResponseBase.AbstractBuilder<StatsResponse.Builder>

org.opensearch.client.opensearch.cluster.StatsResponse.Builder

All Implemented Interfaces:

ObjectBuilder<StatsResponse>

Enclosing class:

StatsResponse

public static class StatsResponse.Builder
extends NodesResponseBase.AbstractBuilder<StatsResponse.Builder>
implements ObjectBuilder<StatsResponse>

Builder for StatsResponse.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StatsResponse	build()	Builds a StatsResponse.
StatsResponse.Builder	clusterName(java.lang.String value)	Name of the cluster, based on the Cluster name setting setting.
StatsResponse.Builder	clusterUuid(java.lang.String value)	Unique identifier for the cluster.
StatsResponse.Builder	indices(java.util.function.Function<ClusterIndices.Builder,ObjectBuilder<ClusterIndices>> fn)	Contains statistics about indices with shards assigned to selected nodes.
StatsResponse.Builder	indices(ClusterIndices value)	Contains statistics about indices with shards assigned to selected nodes.
StatsResponse.Builder	nodes(java.util.function.Function<ClusterNodes.Builder,ObjectBuilder<ClusterNodes>> fn)	Contains statistics about nodes selected by the request's node filters.
StatsResponse.Builder	nodes(ClusterNodes value)	Contains statistics about nodes selected by the request's node filters.
protected StatsResponse.Builder	self()
StatsResponse.Builder	status(jakarta.json.JsonValue value)	Health status of the cluster, based on the state of its primary and replica shards.
StatsResponse.Builder	timestamp(java.lang.Number value)	Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed.

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

nodeStats, nodeStats

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

clusterName

public StatsResponse.Builder clusterName(java.lang.String value)

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

clusterUuid

public StatsResponse.Builder clusterUuid(java.lang.String value)

Unique identifier for the cluster. API name: cluster_uuid

indices

public StatsResponse.Builder indices(ClusterIndices value)

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

indices

public StatsResponse.Builder indices(java.util.function.Function<ClusterIndices.Builder,ObjectBuilder<ClusterIndices>> fn)

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

nodes

public StatsResponse.Builder nodes(ClusterNodes value)

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

nodes

public StatsResponse.Builder nodes(java.util.function.Function<ClusterNodes.Builder,ObjectBuilder<ClusterNodes>> fn)

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

status

public StatsResponse.Builder status(jakarta.json.JsonValue value)

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

timestamp

public StatsResponse.Builder timestamp(java.lang.Number value)

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

self

protected StatsResponse.Builder self()

Specified by:

self in class NodesResponseBase.AbstractBuilder<StatsResponse.Builder>

build

public StatsResponse build()

Builds a StatsResponse.

Specified by:

build in interface ObjectBuilder<StatsResponse>

Throws:

java.lang.NullPointerException - if some of the required fields are null.