Package co.elastic.clients.elasticsearch.cat

Enum Class CatSegmentsColumn

java.lang.Object
java.lang.Enum<CatSegmentsColumn>
co.elastic.clients.elasticsearch.cat.CatSegmentsColumn
All Implemented Interfaces:
JsonEnum, JsonpSerializable, Serializable, Comparable<CatSegmentsColumn>, Constable
@JsonpDeserializable public enum CatSegmentsColumn extends Enum<CatSegmentsColumn> implements JsonEnum
See Also:

  • Enum Constant Details

    • Index

      public static final CatSegmentsColumn Index
      The name of the index.

    • Shard

      public static final CatSegmentsColumn Shard
      The name of the shard.

    • Prirep

      public static final CatSegmentsColumn Prirep
      The shard type. Returned values are 'primary' or 'replica'.

    • Ip

      public static final CatSegmentsColumn Ip
      IP address of the segment’s shard, such as '127.0.1.1'.

    • Segment

      public static final CatSegmentsColumn Segment
      The name of the segment, such as '_0'. The segment name is derived from the segment generation and used internally to create file names in the directory of the shard.

    • Generation

      public static final CatSegmentsColumn Generation
      Generation number, such as '0'. Elasticsearch increments this generation number for each segment written. Elasticsearch then uses this number to derive the segment name.

    • DocsCount

      public static final CatSegmentsColumn DocsCount
      The number of documents as reported by Lucene. 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.

    • DocsDeleted

      public static final CatSegmentsColumn DocsDeleted
      The number of deleted documents as reported by Lucene, which may 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.

    • Size

      public static final CatSegmentsColumn Size
      The disk space used by the segment, such as '50kb'.

    • SizeMemory

      public static final CatSegmentsColumn SizeMemory
      The bytes of segment data stored in memory for efficient search, such as '1264'. A value of '-1' indicates Elasticsearch was unable to compute this number.

    • Committed

      public static final CatSegmentsColumn Committed
      If 'true', the segments 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.

    • Searchable

      public static final CatSegmentsColumn Searchable
      If 'true', the segment is searchable. If 'false', the segment has most likely been written to disk but needs a refresh to be searchable.

    • Version

      public static final CatSegmentsColumn Version
      The version of Lucene used to write the segment.

    • Compound

      public static final CatSegmentsColumn Compound
      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.

    • Id

      public static final CatSegmentsColumn Id
      The ID of the node, such as 'k0zy'.

  • Field Details

  • Method Details

    • values

      public static CatSegmentsColumn[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CatSegmentsColumn valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • jsonValue

      public String jsonValue()
      Specified by:
      jsonValue in interface JsonEnum

    • aliases

      public String[] aliases()
      Specified by:
      aliases in interface JsonEnum