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:
ObjectBuilder<ClusterStatsResponse>
- Enclosing class:
- ClusterStatsResponse
public static class ClusterStatsResponse.Builder extends NodesResponseBase.AbstractBuilder<ClusterStatsResponse.Builder> implements ObjectBuilder<ClusterStatsResponse>
Builder forClusterStatsResponse.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ClusterStatsResponsebuild()Builds aClusterStatsResponse.ClusterStatsResponse.BuilderclusterName(java.lang.String value)Required - Name of the cluster, based on the Cluster name setting setting.ClusterStatsResponse.BuilderclusterUuid(java.lang.String value)Required - Unique identifier for the cluster.ClusterStatsResponse.Builderindices(java.util.function.Function<ClusterIndices.Builder,ObjectBuilder<ClusterIndices>> fn)Required - Contains statistics about indices with shards assigned to selected nodes.ClusterStatsResponse.Builderindices(ClusterIndices value)Required - Contains statistics about indices with shards assigned to selected nodes.ClusterStatsResponse.Buildernodes(java.util.function.Function<ClusterNodes.Builder,ObjectBuilder<ClusterNodes>> fn)Required - Contains statistics about nodes selected by the request's node filters.ClusterStatsResponse.Buildernodes(ClusterNodes value)Required - Contains statistics about nodes selected by the request's node filters.protected ClusterStatsResponse.Builderself()ClusterStatsResponse.Builderstatus(HealthStatus value)Required - Health status of the cluster, based on the state of its primary and replica shards.ClusterStatsResponse.Buildertimestamp(long value)Required - 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 org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
-
-
-
Method Detail
-
clusterName
public final ClusterStatsResponse.Builder clusterName(java.lang.String value)
Required - Name of the cluster, based on the Cluster name setting setting.API name:
cluster_name
-
clusterUuid
public final ClusterStatsResponse.Builder clusterUuid(java.lang.String value)
Required - Unique identifier for the cluster.API name:
cluster_uuid
-
indices
public final ClusterStatsResponse.Builder indices(ClusterIndices value)
Required - Contains statistics about indices with shards assigned to selected nodes.API name:
indices
-
indices
public final ClusterStatsResponse.Builder indices(java.util.function.Function<ClusterIndices.Builder,ObjectBuilder<ClusterIndices>> fn)
Required - Contains statistics about indices with shards assigned to selected nodes.API name:
indices
-
nodes
public final ClusterStatsResponse.Builder nodes(ClusterNodes value)
Required - Contains statistics about nodes selected by the request's node filters.API name:
nodes
-
nodes
public final ClusterStatsResponse.Builder nodes(java.util.function.Function<ClusterNodes.Builder,ObjectBuilder<ClusterNodes>> fn)
Required - Contains statistics about nodes selected by the request's node filters.API name:
nodes
-
status
public final ClusterStatsResponse.Builder status(HealthStatus value)
Required - Health status of the cluster, based on the state of its primary and replica shards.API name:
status
-
timestamp
public final ClusterStatsResponse.Builder timestamp(long value)
Required - Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed.API name:
timestamp
-
self
protected ClusterStatsResponse.Builder self()
- Specified by:
selfin classNodesResponseBase.AbstractBuilder<ClusterStatsResponse.Builder>
-
build
public ClusterStatsResponse build()
Builds aClusterStatsResponse.- Specified by:
buildin interfaceObjectBuilder<ClusterStatsResponse>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-
-