Package org.opensearch.client.opensearch._types

Class QueryCacheStats.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

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

    • cacheCount

      @Nonnull public final QueryCacheStats.Builder cacheCount(long value)
      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

      @Nonnull public final QueryCacheStats.Builder cacheSize(long value)
      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

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

      API name: evictions

    • hitCount

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

      API name: hit_count

    • memorySize

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

      API name: memory_size

    • memorySizeInBytes

      @Nonnull public final QueryCacheStats.Builder memorySizeInBytes(long value)
      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

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

      API name: miss_count

    • totalCount

      @Nonnull public final QueryCacheStats.Builder totalCount(long value)
      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

    • build

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