Package org.opensearch.client.opensearch._types

Class SearchStats.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.SearchStats.Builder
All Implemented Interfaces:
CopyableBuilder<SearchStats.Builder,SearchStats>, MutableBuilder<SearchStats.Builder,SearchStats>, ObjectBuilder<SearchStats>
Enclosing class:
SearchStats
public static class SearchStats.Builder extends ObjectBuilderBase implements CopyableBuilder<SearchStats.Builder,SearchStats>
Builder for SearchStats.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public SearchStats.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<SearchStats.Builder,SearchStats>
      Returns:
      a new builder instance.

    • concurrentAvgSliceCount

      @Nonnull public final SearchStats.Builder concurrentAvgSliceCount(@Nullable Long value)
      The average slice count of all search requests. This is computed as the total slice count divided by the total number of concurrent search requests.

      API name: concurrent_avg_slice_count

    • concurrentQueryCurrent

      @Nonnull public final SearchStats.Builder concurrentQueryCurrent(@Nullable Long value)
      The number of currently running query operations using concurrent segment search.

      API name: concurrent_query_current

    • concurrentQueryTime

      @Nonnull public final SearchStats.Builder concurrentQueryTime(@Nullable Time value)
      API name: concurrent_query_time

    • concurrentQueryTime

      @Nonnull public final SearchStats.Builder concurrentQueryTime(Function<Time.Builder,ObjectBuilder<Time>> fn)
      API name: concurrent_query_time

    • concurrentQueryTimeInMillis

      @Nonnull public final SearchStats.Builder concurrentQueryTimeInMillis(@Nullable Long value)
      The total amount of time taken by all query operations using concurrent segment search, in milliseconds.

      API name: concurrent_query_time_in_millis

    • concurrentQueryTotal

      @Nonnull public final SearchStats.Builder concurrentQueryTotal(@Nullable Long value)
      The total number of query operations using concurrent segment search.

      API name: concurrent_query_total

    • fetchCurrent

      @Nonnull public final SearchStats.Builder fetchCurrent(long value)
      Required - The number of currently running shard fetch operations.

      API name: fetch_current

    • fetchTime

      @Nonnull public final SearchStats.Builder fetchTime(@Nullable Time value)
      The total amount of time taken to complete all shard fetch operations.

      API name: fetch_time

    • fetchTime

      @Nonnull public final SearchStats.Builder fetchTime(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The total amount of time taken to complete all shard fetch operations.

      API name: fetch_time

    • fetchTimeInMillis

      @Nonnull public final SearchStats.Builder fetchTimeInMillis(long value)
      Required - The total amount of time taken to complete all shard fetch operations, in milliseconds.

      API name: fetch_time_in_millis

    • fetchTotal

      @Nonnull public final SearchStats.Builder fetchTotal(long value)
      Required - The total number of shard fetch operations.

      API name: fetch_total

    • groups

      @Nonnull public final SearchStats.Builder groups(Map<String,SearchStats> map)
      The search statistics grouped by search groups.

      API name: groups

      Adds all elements of map to groups.

    • groups

      @Nonnull public final SearchStats.Builder groups(String key, SearchStats value)
      The search statistics grouped by search groups.

      API name: groups

      Adds an entry to groups.

    • groups

      @Nonnull public final SearchStats.Builder groups(String key, Function<SearchStats.Builder,ObjectBuilder<SearchStats>> fn)
      The search statistics grouped by search groups.

      API name: groups

      Adds a value to groups using a builder lambda.

    • openContexts

      @Nonnull public final SearchStats.Builder openContexts(@Nullable Long value)
      The number of open search contexts.

      API name: open_contexts

    • pointInTimeCurrent

      @Nonnull public final SearchStats.Builder pointInTimeCurrent(@Nullable Long value)
      The number of currently open shard PIT contexts.

      API name: point_in_time_current

    • pointInTimeTime

      @Nonnull public final SearchStats.Builder pointInTimeTime(@Nullable Time value)
      API name: point_in_time_time

    • pointInTimeTime

      @Nonnull public final SearchStats.Builder pointInTimeTime(Function<Time.Builder,ObjectBuilder<Time>> fn)
      API name: point_in_time_time

    • pointInTimeTimeInMillis

      @Nonnull public final SearchStats.Builder pointInTimeTimeInMillis(@Nullable Long value)
      The amount of time that shard PIT contexts have been held open since the node last restarted, in milliseconds.

      API name: point_in_time_time_in_millis

    • pointInTimeTotal

      @Nonnull public final SearchStats.Builder pointInTimeTotal(@Nullable Long value)
      The total number of shard Point in Time (PIT) contexts created (completed and active) since the node last restarted.

      API name: point_in_time_total

    • queryCurrent

      @Nonnull public final SearchStats.Builder queryCurrent(long value)
      Required - The number of currently running shard query operations.

      API name: query_current

    • queryTime

      @Nonnull public final SearchStats.Builder queryTime(@Nullable Time value)
      The total amount of time taken to complete all shard query operations.

      API name: query_time

    • queryTime

      @Nonnull public final SearchStats.Builder queryTime(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The total amount of time taken to complete all shard query operations.

      API name: query_time

    • queryTimeInMillis

      @Nonnull public final SearchStats.Builder queryTimeInMillis(long value)
      Required - The total amount of time taken to complete all shard query operations, in milliseconds.

      API name: query_time_in_millis

    • queryTotal

      @Nonnull public final SearchStats.Builder queryTotal(long value)
      Required - The total number of shard query operations.

      API name: query_total

    • request

      @Nonnull public final SearchStats.Builder request(Map<String,RequestStats> map)
      Statistics related to coordinator search operations for the node.

      API name: request

      Adds all elements of map to request.

    • request

      @Nonnull public final SearchStats.Builder request(String key, RequestStats value)
      Statistics related to coordinator search operations for the node.

      API name: request

      Adds an entry to request.

    • request

      @Nonnull public final SearchStats.Builder request(String key, Function<RequestStats.Builder,ObjectBuilder<RequestStats>> fn)
      Statistics related to coordinator search operations for the node.

      API name: request

      Adds a value to request using a builder lambda.

    • scrollCurrent

      @Nonnull public final SearchStats.Builder scrollCurrent(long value)
      Required - The number of shard scroll operations that are currently running.

      API name: scroll_current

    • scrollTime

      @Nonnull public final SearchStats.Builder scrollTime(@Nullable Time value)
      The total amount of time taken to complete all shard scroll operations.

      API name: scroll_time

    • scrollTime

      @Nonnull public final SearchStats.Builder scrollTime(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The total amount of time taken to complete all shard scroll operations.

      API name: scroll_time

    • scrollTimeInMillis

      @Nonnull public final SearchStats.Builder scrollTimeInMillis(long value)
      Required - The total amount of time taken to complete all shard scroll operations, in milliseconds.

      API name: scroll_time_in_millis

    • scrollTotal

      @Nonnull public final SearchStats.Builder scrollTotal(long value)
      Required - The total number of shard scroll operations.

      API name: scroll_total

    • searchIdleReactivateCountTotal

      @Nonnull public final SearchStats.Builder searchIdleReactivateCountTotal(@Nullable Long value)
      The total number of idle search reactivations.

      API name: search_idle_reactivate_count_total

    • suggestCurrent

      @Nonnull public final SearchStats.Builder suggestCurrent(long value)
      Required - The number of currently running shard suggest operations.

      API name: suggest_current

    • suggestTime

      @Nonnull public final SearchStats.Builder suggestTime(@Nullable Time value)
      The total amount of time take to complete all shard suggest operations.

      API name: suggest_time

    • suggestTime

      @Nonnull public final SearchStats.Builder suggestTime(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The total amount of time take to complete all shard suggest operations.

      API name: suggest_time

    • suggestTimeInMillis

      @Nonnull public final SearchStats.Builder suggestTimeInMillis(long value)
      Required - The total amount of time taken to complete all shard suggest operations, in milliseconds.

      API name: suggest_time_in_millis

    • suggestTotal

      @Nonnull public final SearchStats.Builder suggestTotal(long value)
      Required - The total number of shard suggest operations.

      API name: suggest_total

    • build

      @Nonnull public SearchStats build()
      Builds a SearchStats.
      Specified by:
      build in interface ObjectBuilder<SearchStats>
      Throws:
      NullPointerException - if some of the required fields are null.