Module org.elasticsearch.server
Package org.elasticsearch.index.codec.tsdb.pipeline

Enum Class StageId

java.lang.Object
java.lang.Enum<StageId>
org.elasticsearch.index.codec.tsdb.pipeline.StageId
All Implemented Interfaces:
Serializable, Comparable<StageId>, Constable
public enum StageId extends Enum<StageId>
Unique byte identifiers for pipeline stages, persisted in the encoded data.

Stage IDs are the wire format contract between encoder and decoder. Once assigned, an ID must never change or be reused, as doing so would break the ability to decode existing data. ID 0x00 is reserved for test-only stages (see TestPayloadCodecStage).

Transform stages (IDs below 0xA1) are applied in sequence and are reversible. Terminal payload stages (IDs at or above 0xA1) serialize values to bytes as the final step of the encode pipeline. ID 0xA0 is reserved for test-only payload stages.

  • Enum Constant Details

    • DELTA_STAGE

      public static final StageId DELTA_STAGE
      Delta encoding transform stage.

    • OFFSET_STAGE

      public static final StageId OFFSET_STAGE
      Offset removal transform stage.

    • GCD_STAGE

      public static final StageId GCD_STAGE
      GCD factoring transform stage.

    • BITPACK_PAYLOAD

      public static final StageId BITPACK_PAYLOAD
      Bit-packing terminal payload stage.

  • Field Details

    • id

      public final byte id
      Persisted byte identifier. Must never change once assigned.

    • displayName

      public final String displayName
      Human-readable name for logging and diagnostics.

  • Method Details

    • values

      public static StageId[] 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 StageId 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

    • fromId

      public static StageId fromId(byte id)
      Resolves a persisted byte identifier back to its StageId constant.
      Parameters:
      id - the byte identifier read from the encoded data
      Returns:
      the corresponding StageId
      Throws:
      IllegalArgumentException - if the identifier is unknown