Package co.elastic.clients.elasticsearch.cat.segments

Class SegmentsRecord.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<SegmentsRecord.Builder>
co.elastic.clients.elasticsearch.cat.segments.SegmentsRecord.Builder
All Implemented Interfaces:
WithJson<SegmentsRecord.Builder>, ObjectBuilder<SegmentsRecord>
Enclosing class:
SegmentsRecord
public static class SegmentsRecord.Builder extends WithJsonObjectBuilderBase<SegmentsRecord.Builder> implements ObjectBuilder<SegmentsRecord>
Builder for SegmentsRecord.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • index

      public final SegmentsRecord.Builder index(@Nullable String value)
      The index name.

      API name: index

    • shard

      public final SegmentsRecord.Builder shard(@Nullable String value)
      The shard name.

      API name: shard

    • prirep

      public final SegmentsRecord.Builder prirep(@Nullable String value)
      The shard type: primary or replica.

      API name: prirep

    • ip

      public final SegmentsRecord.Builder ip(@Nullable String value)
      The IP address of the node where it lives.

      API name: ip

    • id

      public final SegmentsRecord.Builder id(@Nullable String value)
      The unique identifier of the node where it lives.

      API name: id

    • segment

      public final SegmentsRecord.Builder segment(@Nullable String value)
      The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard.

      API name: segment

    • generation

      public final SegmentsRecord.Builder generation(@Nullable String value)
      The segment generation number. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name.

      API name: generation

    • docsCount

      public final SegmentsRecord.Builder docsCount(@Nullable String value)
      The number of documents in the segment. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment.

      API name: docs.count

    • docsDeleted

      public final SegmentsRecord.Builder docsDeleted(@Nullable String value)
      The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.

      API name: docs.deleted

    • size

      public final SegmentsRecord.Builder size(@Nullable String value)
      The segment size in bytes.

      API name: size

    • sizeMemory

      public final SegmentsRecord.Builder sizeMemory(@Nullable String value)
      The segment memory in bytes. A value of -1 indicates Elasticsearch was unable to compute this number.

      API name: size.memory

    • committed

      public final SegmentsRecord.Builder committed(@Nullable String value)
      If true, the segment is synced to disk. Segments that are synced can survive a hard reboot. If false, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.

      API name: committed

    • searchable

      public final SegmentsRecord.Builder searchable(@Nullable String value)
      If true, the segment is searchable. If false, the segment has most likely been written to disk but needs a refresh to be searchable.

      API name: searchable

    • version

      public final SegmentsRecord.Builder version(@Nullable String value)
      The version of Lucene used to write the segment.

      API name: version

    • compound

      public final SegmentsRecord.Builder compound(@Nullable String value)
      If true, the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors.

      API name: compound

    • self

      protected SegmentsRecord.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<SegmentsRecord.Builder>

    • build

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