Enum Class JsonOutputShape

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

public enum JsonOutputShape extends Enum<JsonOutputShape>
Output shape of the ResultWriterOptions.ObjectType.JSON sink.
  • NDJSON: one JSON object per line, no enclosing array. The default; streams and splits by line.
  • STRUCTURED: one document, {"schema":{...},"rows":[{...},{...}]}, for non-streaming clients.
  • Enum Constant Details

  • Method Details

    • values

      public static JsonOutputShape[] 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 JsonOutputShape 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
    • fromString

      public static Optional<JsonOutputShape> fromString(String value)
      Parses a shape name.
      Parameters:
      value - the shape name.
      Returns:
      the matching shape, or empty if none matches.