The JSON to Tuple Java operator converts JSON strings to StreamBase tuples. The operator's input port schema must contain a user defined string field that passes an JSON-encoded string to the operator. The operator parses the JSON string and populates tuple fields corresponding to the data found in the string. Each JSON string enqueued to the operator results in a single tuple emitted on its output port.
The operator's output schema determines the set of fields retrieved from the JSON string. The hierarchy of the fields in the schema must match that of the elements in the JSON string. Fields not present in the JSON string are set to null in the emitted tuple.
| Property | Description |
|---|---|
| JSON Field Name | The name of the field in the inbound tuple that contains the JSON string to convert to a tuple. |
| Timestamp Format | The format to use when converting time string values to timestamps. |
| Enable Loose Parsing | If enabled, the parsing of the JSON string ignores fields that do not match the schema. |
| Enable Status Port | If enabled (the default), status tuples are sent to port 2. If disabled, No status is reported. If disabled after previously being enabled, the arc connected to port 2 is deleted. |
| Enable Pass Through Fields | If enabled, inbound tuples are copied to the outbound tuple. |
| Pass Through Fields Field Name | The name of the field in the output tuple that is to contain a tuple of all the inbound data. |
| JSON Output Schema | The output schema to convert the JSON string. |
| Log Level | Controls the level of verbosity the adapter uses to send notifications to the console. This setting can be higher than the containing application's log level. If set lower, the system log level is used. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE, and ALL. |
The operator has one input port and two output ports to communicate with the surrounding application.
The JSON to Tuple operator's ports are used as follows:
-
DataIn: The JSON message to be converted to a tuple. The DataIn port can have any schema but must contain at least the field specified by the
JSON Field Nameproperty -
TupleOut: This output port contains one or more top-level fields, each of which is used to receive the results of JSON string. If
Enable Pass Through Fieldsis checked this port will also contain all the fields from the input port using the specifiedPass Through Fields Field Nameproperty as the name -
Status: A tuple is emitted on this port when an attempt to convert an JSON string to a tuple fails. The Status port has the following schema:
-
type, string: Contains the following value describing the type of event that occurred:
-
Convert
-
-
action, string: Contains the following value indicating the conversion failed:
-
Failed
-
-
object, string: Contains a string representation of the input tuple.
-
message, string: Contains a human-readable description of the conversion failure.
-
time, timestamp: Contains the time of the conversion failure.
-
inputTuple, tuple: Contains a copy of the input tuple.
-