Package org.opensearch.client.opensearch._types

Class SearchStats

java.lang.Object
org.opensearch.client.opensearch._types.SearchStats
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<SearchStats.Builder,SearchStats>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class SearchStats extends Object implements PlainJsonSerializable, ToCopyableBuilder<SearchStats.Builder,SearchStats>
The statistics about search operations.

  • Field Details

  • Method Details

    • of

      public static SearchStats of(Function<SearchStats.Builder,ObjectBuilder<SearchStats>> fn)

    • concurrentAvgSliceCount

      @Nullable public final Long concurrentAvgSliceCount()
      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

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

      API name: concurrent_query_current

    • concurrentQueryTime

      @Nullable public final Time concurrentQueryTime()
      API name: concurrent_query_time

    • concurrentQueryTimeInMillis

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

      API name: concurrent_query_time_in_millis

    • concurrentQueryTotal

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

      API name: concurrent_query_total

    • fetchCurrent

      public final long fetchCurrent()
      Required - The number of currently running shard fetch operations.

      API name: fetch_current

    • fetchTime

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

      API name: fetch_time

    • fetchTimeInMillis

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

      API name: fetch_time_in_millis

    • fetchTotal

      public final long fetchTotal()
      Required - The total number of shard fetch operations.

      API name: fetch_total

    • groups

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

      API name: groups

    • openContexts

      @Nullable public final Long openContexts()
      The number of open search contexts.

      API name: open_contexts

    • pointInTimeCurrent

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

      API name: point_in_time_current

    • pointInTimeTime

      @Nullable public final Time pointInTimeTime()
      API name: point_in_time_time

    • pointInTimeTimeInMillis

      @Nullable public final Long pointInTimeTimeInMillis()
      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

      @Nullable public final Long pointInTimeTotal()
      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

      public final long queryCurrent()
      Required - The number of currently running shard query operations.

      API name: query_current

    • queryTime

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

      API name: query_time

    • queryTimeInMillis

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

      API name: query_time_in_millis

    • queryTotal

      public final long queryTotal()
      Required - The total number of shard query operations.

      API name: query_total

    • request

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

      API name: request

    • scrollCurrent

      public final long scrollCurrent()
      Required - The number of shard scroll operations that are currently running.

      API name: scroll_current

    • scrollTime

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

      API name: scroll_time

    • scrollTimeInMillis

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

      API name: scroll_time_in_millis

    • scrollTotal

      public final long scrollTotal()
      Required - The total number of shard scroll operations.

      API name: scroll_total

    • searchIdleReactivateCountTotal

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

      API name: search_idle_reactivate_count_total

    • suggestCurrent

      public final long suggestCurrent()
      Required - The number of currently running shard suggest operations.

      API name: suggest_current

    • suggestTime

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

      API name: suggest_time

    • suggestTimeInMillis

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

      API name: suggest_time_in_millis

    • suggestTotal

      public final long suggestTotal()
      Required - The total number of shard suggest operations.

      API name: suggest_total

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toBuilder

      @Nonnull public SearchStats.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchStats.Builder,SearchStats>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static SearchStats.Builder builder()

    • setupSearchStatsDeserializer

      protected static void setupSearchStatsDeserializer(ObjectDeserializer<SearchStats.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object