Package org.opensearch.client.opensearch._types

Class QueryCacheStats

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

  • Field Details

  • Method Details

    • of

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

    • cacheCount

      public final long cacheCount()
      Required - The total number of entries added to the query cache across all shards assigned to the selected nodes. This number includes all current and evicted entries.

      API name: cache_count

    • cacheSize

      public final long cacheSize()
      Required - The total number of entries currently stored in the query cache across all shards assigned to the selected nodes.

      API name: cache_size

    • evictions

      public final long evictions()
      Required - The total number of query cache evictions across all shards assigned to the selected nodes.

      API name: evictions

    • hitCount

      public final long hitCount()
      Required - The total number of query cache hits across all shards assigned to the selected nodes.

      API name: hit_count

    • memorySize

      @Nullable public final String memorySize()
      The human-readable amount of memory used for the query cache.

      API name: memory_size

    • memorySizeInBytes

      public final long memorySizeInBytes()
      Required - The total amount, in bytes, of memory used for the query cache across all shards assigned to the selected nodes.

      API name: memory_size_in_bytes

    • missCount

      public final long missCount()
      Required - The total number of query cache misses across all shards assigned to the selected nodes.

      API name: miss_count

    • totalCount

      public final long totalCount()
      Required - The total number of hits and misses stored in the query cache across all shards assigned to the selected nodes.

      API name: total_count

    • 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 QueryCacheStats.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<QueryCacheStats.Builder,QueryCacheStats>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static QueryCacheStats.Builder builder()

    • setupQueryCacheStatsDeserializer

      protected static void setupQueryCacheStatsDeserializer(ObjectDeserializer<QueryCacheStats.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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