Package org.opensearch.client.opensearch.nodes

Class NodesStatsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.nodes.NodesStatsRequest

public class NodesStatsRequest
extends RequestBase

Returns statistical information about nodes in the cluster.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<NodesStatsRequest,NodesStatsResponse,ErrorResponse>	_ENDPOINT	Endpoint "nodes.stats".

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Period to wait for a connection to the cluster-manager node.
java.util.List<java.lang.String>	completionFields()	Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
java.util.List<java.lang.String>	fielddataFields()	Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
java.util.List<java.lang.String>	fields()	Comma-separated list or wildcard expressions of fields to include in the statistics.
java.lang.Boolean	groups()	Comma-separated list of search groups to include in the search statistics.
java.lang.Boolean	includeSegmentFileSizes()	If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
java.lang.Boolean	includeUnloadedSegments()	If set to true segment stats will include stats for segments that are not currently loaded into memory
java.util.List<java.lang.String>	indexMetric()	Limit the information returned for indices metric to the specific index metrics.
Level	level()	Indicates whether statistics are aggregated at the cluster, index, or shard level.
Time	masterTimeout()	Deprecated.
java.util.List<java.lang.String>	metric()	Limit the information returned to the specified metrics
java.util.List<java.lang.String>	nodeId()	Comma-separated list of node IDs or names used to limit returned information.
static NodesStatsRequest	of(java.util.function.Function<NodesStatsRequest.Builder,ObjectBuilder<NodesStatsRequest>> fn)
Time	timeout()	Period to wait for a response.
java.util.List<java.lang.String>	types()	A comma-separated list of document types for the indexing index metric.

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<NodesStatsRequest,NodesStatsResponse,ErrorResponse> _ENDPOINT

Endpoint "nodes.stats".

Method Detail

of

public static NodesStatsRequest of(java.util.function.Function<NodesStatsRequest.Builder,ObjectBuilder<NodesStatsRequest>> fn)

completionFields

public final java.util.List<java.lang.String> completionFields()

Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.

API name: completion_fields

fielddataFields

public final java.util.List<java.lang.String> fielddataFields()

Comma-separated list or wildcard expressions of fields to include in fielddata statistics.

API name: fielddata_fields

fields

public final java.util.List<java.lang.String> fields()

Comma-separated list or wildcard expressions of fields to include in the statistics.

API name: fields

groups

@Nullable
public final java.lang.Boolean groups()

Comma-separated list of search groups to include in the search statistics.

API name: groups

includeSegmentFileSizes

@Nullable
public final java.lang.Boolean includeSegmentFileSizes()

If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).

API name: include_segment_file_sizes

includeUnloadedSegments

@Nullable
public final java.lang.Boolean includeUnloadedSegments()

If set to true segment stats will include stats for segments that are not currently loaded into memory

API name: include_unloaded_segments

indexMetric

public final java.util.List<java.lang.String> indexMetric()

Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.

API name: index_metric

level

@Nullable
public final Level level()

Indicates whether statistics are aggregated at the cluster, index, or shard level.

API name: level

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

metric

public final java.util.List<java.lang.String> metric()

Limit the information returned to the specified metrics

API name: metric

nodeId

public final java.util.List<java.lang.String> nodeId()

Comma-separated list of node IDs or names used to limit returned information.

API name: node_id

timeout

@Nullable
public final Time timeout()

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

types

public final java.util.List<java.lang.String> types()

A comma-separated list of document types for the indexing index metric.

API name: types