Class DocStats.Builder

All Implemented Interfaces:
WithJson<DocStats.Builder>, ObjectBuilder<DocStats>
Enclosing class:
DocStats

public static class DocStats.Builder extends WithJsonObjectBuilderBase<DocStats.Builder> implements ObjectBuilder<DocStats>
Builder for DocStats.
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • count

      public final DocStats.Builder count(long value)
      Required - Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.

      API name: count

    • deleted

      public final DocStats.Builder deleted(@Nullable Long value)
      Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.

      API name: deleted

    • totalSizeInBytes

      public final DocStats.Builder totalSizeInBytes(long value)
      Required - Returns the total size in bytes of all documents in this stats. This value may be more reliable than store_stats.size_in_bytes in estimating the index size.

      API name: total_size_in_bytes

    • totalSize

      public final DocStats.Builder totalSize(@Nullable String value)
      Human readable total_size_in_bytes

      API name: total_size

    • self

      protected DocStats.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<DocStats.Builder>
    • build

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