Module com.darkcollective.relix.lang.ast
Package com.darkcollective.relix.lang.ast.source

Record Class JsonExtractSpec

java.lang.Object
java.lang.Record
com.darkcollective.relix.lang.ast.source.JsonExtractSpec
Record Components:
jsonPath - the JSONPath root expression; must not be blank
All Implemented Interfaces:
ExtractSpec
public record JsonExtractSpec(String jsonPath) extends Record implements ExtractSpec
Extracts tabular data from a JSON response body.

The jsonPath() expression locates the array of objects that becomes the rows of the relation. Use "$." for a top-level object (single-row result), "$.items[*]" for an array field, or "$[*]" for a root-level array.

Syntax: extract: json("$.items[*]")

  • Constructor Summary

    Constructors
    Constructor
    Description
    JsonExtractSpec(String jsonPath)
    Creates an instance of a JsonExtractSpec record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    jsonPath()
    Returns the value of the jsonPath record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • JsonExtractSpec

      public JsonExtractSpec(String jsonPath)
      Creates an instance of a JsonExtractSpec record class.
      Parameters:
      jsonPath - the value for the jsonPath record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • jsonPath

      public String jsonPath()
      Returns the value of the jsonPath record component.
      Returns:
      the value of the jsonPath record component