Package org.opensearch.client.opensearch.nodes

Class NodesStatsRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • completionFields

        public final NodesStatsRequest.Builder completionFields​(java.util.List<java.lang.String> list)
        Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.

        API name: completion_fields

        Adds all elements of list to completionFields.

      • completionFields

        public final NodesStatsRequest.Builder completionFields​(java.lang.String value,
                                                        java.lang.String... values)
        Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.

        API name: completion_fields

        Adds one or more values to completionFields.

      • fielddataFields

        public final NodesStatsRequest.Builder fielddataFields​(java.util.List<java.lang.String> list)
        Comma-separated list or wildcard expressions of fields to include in fielddata statistics.

        API name: fielddata_fields

        Adds all elements of list to fielddataFields.

      • fielddataFields

        public final NodesStatsRequest.Builder fielddataFields​(java.lang.String value,
                                                       java.lang.String... values)
        Comma-separated list or wildcard expressions of fields to include in fielddata statistics.

        API name: fielddata_fields

        Adds one or more values to fielddataFields.

      • fields

        public final NodesStatsRequest.Builder fields​(java.util.List<java.lang.String> list)
        Comma-separated list or wildcard expressions of fields to include in the statistics.

        API name: fields

        Adds all elements of list to fields.

      • fields

        public final NodesStatsRequest.Builder fields​(java.lang.String value,
                                              java.lang.String... values)
        Comma-separated list or wildcard expressions of fields to include in the statistics.

        API name: fields

        Adds one or more values to fields.

      • groups

        public final NodesStatsRequest.Builder groups​(@Nullable
                                              java.lang.Boolean value)
        Comma-separated list of search groups to include in the search statistics.

        API name: groups

      • includeSegmentFileSizes

        public final NodesStatsRequest.Builder includeSegmentFileSizes​(@Nullable
                                                               java.lang.Boolean value)
        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

        public final NodesStatsRequest.Builder includeUnloadedSegments​(@Nullable
                                                               java.lang.Boolean value)
        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 NodesStatsRequest.Builder indexMetric​(java.util.List<java.lang.String> list)
        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

        Adds all elements of list to indexMetric.

      • indexMetric

        public final NodesStatsRequest.Builder indexMetric​(java.lang.String value,
                                                   java.lang.String... values)
        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

        Adds one or more values to indexMetric.

      • level

        public final NodesStatsRequest.Builder level​(@Nullable
                                             Level value)
        Indicates whether statistics are aggregated at the cluster, index, or shard level.

        API name: level

      • masterTimeout

        @Deprecated
public final NodesStatsRequest.Builder masterTimeout​(@Nullable
                                                     Time value)
        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

      • masterTimeout

        @Deprecated
public final NodesStatsRequest.Builder masterTimeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
        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

        public final NodesStatsRequest.Builder clusterManagerTimeout​(@Nullable
                                                             Time value)
        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

      • clusterManagerTimeout

        public final NodesStatsRequest.Builder clusterManagerTimeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
        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 NodesStatsRequest.Builder metric​(java.util.List<java.lang.String> list)
        Limit the information returned to the specified metrics

        API name: metric

        Adds all elements of list to metric.

      • metric

        public final NodesStatsRequest.Builder metric​(java.lang.String value,
                                              java.lang.String... values)
        Limit the information returned to the specified metrics

        API name: metric

        Adds one or more values to metric.

      • nodeId

        public final NodesStatsRequest.Builder nodeId​(java.util.List<java.lang.String> list)
        Comma-separated list of node IDs or names used to limit returned information.

        API name: node_id

        Adds all elements of list to nodeId.

      • nodeId

        public final NodesStatsRequest.Builder nodeId​(java.lang.String value,
                                              java.lang.String... values)
        Comma-separated list of node IDs or names used to limit returned information.

        API name: node_id

        Adds one or more values to nodeId.

      • timeout

        public final NodesStatsRequest.Builder timeout​(@Nullable
                                               Time value)
        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

      • timeout

        public final NodesStatsRequest.Builder timeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
        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 NodesStatsRequest.Builder types​(java.util.List<java.lang.String> list)
        A comma-separated list of document types for the indexing index metric.

        API name: types

        Adds all elements of list to types.

      • types

        public final NodesStatsRequest.Builder types​(java.lang.String value,
                                             java.lang.String... values)
        A comma-separated list of document types for the indexing index metric.

        API name: types

        Adds one or more values to types.