Package org.opensearch.client.opensearch.cluster

Class ClusterStatsResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.cluster.ClusterStatsResponse.Builder

All Implemented Interfaces:

CopyableBuilder<ClusterStatsResponse.Builder,ClusterStatsResponse>, MutableBuilder<ClusterStatsResponse.Builder,ClusterStatsResponse>, ObjectBuilder<ClusterStatsResponse>

Enclosing class:

ClusterStatsResponse

public static class ClusterStatsResponse.Builder
extends NodesResponseBase.AbstractBuilder<ClusterStatsResponse.Builder>
implements CopyableBuilder<ClusterStatsResponse.Builder,ClusterStatsResponse>

Builder for ClusterStatsResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClusterStatsResponse	build()	Builds a ClusterStatsResponse.
final ClusterStatsResponse.Builder	clusterName(String value)	Required - The name of the cluster.
final ClusterStatsResponse.Builder	clusterUuid(String value)	Required - The unique identifier of the cluster.
ClusterStatsResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ClusterStatsResponse.Builder	indices(Function<ClusterIndices.Builder,ObjectBuilder<ClusterIndices>> fn)	Displays statistics about indexes in the cluster.
final ClusterStatsResponse.Builder	indices(ClusterIndices value)	Displays statistics about indexes in the cluster.
final ClusterStatsResponse.Builder	nodes(Function<ClusterNodes.Builder,ObjectBuilder<ClusterNodes>> fn)	Displays statistics about nodes selected by the request's node filters.
final ClusterStatsResponse.Builder	nodes(ClusterNodes value)	Displays statistics about nodes selected by the request's node filters.
protected ClusterStatsResponse.Builder	self()
final ClusterStatsResponse.Builder	status(HealthStatus value)	Required - The health status of the cluster, based on the state of its primary and replica shards.
final ClusterStatsResponse.Builder	timestamp(long value)	Required - The Unix timestamp, in milliseconds, indicating when any cluster statistics were last refreshed.

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

nodeStats, nodeStats

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ClusterStatsResponse.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ClusterStatsResponse.Builder,ClusterStatsResponse>

Returns:

a new builder instance.

self

@Nonnull
protected ClusterStatsResponse.Builder self()

Specified by:

self in class NodesResponseBase.AbstractBuilder<ClusterStatsResponse.Builder>

clusterName

@Nonnull
public final ClusterStatsResponse.Builder clusterName(String value)

Required - The name of the cluster.

API name: cluster_name

clusterUuid

@Nonnull
public final ClusterStatsResponse.Builder clusterUuid(String value)

Required - The unique identifier of the cluster.

API name: cluster_uuid

indices

@Nonnull
public final ClusterStatsResponse.Builder indices(@Nullable
 ClusterIndices value)

Displays statistics about indexes in the cluster.

API name: indices

indices

@Nonnull
public final ClusterStatsResponse.Builder indices(Function<ClusterIndices.Builder,ObjectBuilder<ClusterIndices>> fn)

Displays statistics about indexes in the cluster.

API name: indices

nodes

@Nonnull
public final ClusterStatsResponse.Builder nodes(@Nullable
 ClusterNodes value)

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

API name: nodes

nodes

@Nonnull
public final ClusterStatsResponse.Builder nodes(Function<ClusterNodes.Builder,ObjectBuilder<ClusterNodes>> fn)

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

API name: nodes

status

@Nonnull
public final ClusterStatsResponse.Builder status(HealthStatus value)

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

API name: status

timestamp

@Nonnull
public final ClusterStatsResponse.Builder timestamp(long value)

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

API name: timestamp

build

@Nonnull
public ClusterStatsResponse build()

Builds a ClusterStatsResponse.

Specified by:

build in interface ObjectBuilder<ClusterStatsResponse>

Throws:

NullPointerException - if some of the required fields are null.