org.apache.flink.formats.json

Class JsonRowDeserializationSchema

java.lang.Object

org.apache.flink.formats.json.JsonRowDeserializationSchema

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.types.Row>, org.apache.flink.api.java.typeutils.ResultTypeQueryable<org.apache.flink.types.Row>

@PublicEvolving
public class JsonRowDeserializationSchema
extends Object
implements org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.types.Row>

Deserialization schema from JSON to Flink types.

Deserializes a byte[] message as a JSON object and reads the specified fields.

Failure during deserialization are forwarded as wrapped IOExceptions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JsonRowDeserializationSchema(String jsonSchema) Creates a JSON deserialization schema for the given JSON schema.
JsonRowDeserializationSchema(org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> typeInfo) Creates a JSON deserialization schema for the given type information.

Method Summary

Modifier and Type	Method and Description
org.apache.flink.types.Row	deserialize(byte[] message)
org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row>	getProducedType()
boolean	isEndOfStream(org.apache.flink.types.Row nextElement)
void	setFailOnMissingField(boolean failOnMissingField) Configures the failure behaviour if a JSON field is missing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonRowDeserializationSchema

public JsonRowDeserializationSchema(org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> typeInfo)

Creates a JSON deserialization schema for the given type information.

Parameters:

typeInfo - Type information describing the result type. The field names of Row are used to parse the JSON properties.

JsonRowDeserializationSchema

public JsonRowDeserializationSchema(String jsonSchema)

Creates a JSON deserialization schema for the given JSON schema.

Parameters:

jsonSchema - JSON schema describing the result type

See Also:

http://json-schema.org/

Method Detail

deserialize

public org.apache.flink.types.Row deserialize(byte[] message)
                                       throws IOException

Specified by:

deserialize in interface org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.types.Row>

Throws:

IOException

isEndOfStream

public boolean isEndOfStream(org.apache.flink.types.Row nextElement)

Specified by:

isEndOfStream in interface org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.types.Row>

getProducedType

public org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> getProducedType()

Specified by:

getProducedType in interface org.apache.flink.api.java.typeutils.ResultTypeQueryable<org.apache.flink.types.Row>

setFailOnMissingField

public void setFailOnMissingField(boolean failOnMissingField)

Configures the failure behaviour if a JSON field is missing.

By default, a missing field is ignored and the field is set to null.

Parameters:

failOnMissingField - Flag indicating whether to fail or not on a missing field.