Enum Class ValueFormat

java.lang.Object
java.lang.Enum<ValueFormat>
com.inductiveautomation.historian.common.model.binding.ValueFormat
All Implemented Interfaces:
Serializable, Comparable<ValueFormat>, Constable

public enum ValueFormat extends Enum<ValueFormat>
Top-level value-format selector for the historian.query binding.
  • DOCUMENT — sectioned JSON envelope (default).
  • DATASET — single Dataset; annotation/metadata sections dropped with a warning.
  • STREAMING — Flow.Publisher<Row>; gateway-side only, feature-flag gated.
  • Enum Constant Details

  • Method Details

    • values

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