software.amazon.awssdk.services.firehose.model

Class OpenXJsonSerDe

java.lang.Object

software.amazon.awssdk.services.firehose.model.OpenXJsonSerDe

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OpenXJsonSerDe.Builder,OpenXJsonSerDe>

@Generated(value="software.amazon.awssdk:codegen")
public final class OpenXJsonSerDe
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OpenXJsonSerDe.Builder,OpenXJsonSerDe>

The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OpenXJsonSerDe.Builder

Method Summary

Modifier and Type	Method and Description
static OpenXJsonSerDe.Builder	builder()
Boolean	caseInsensitive() When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
Map<String,String>	columnToJsonKeyMappings() Maps column names to JSON keys that aren't identical to the column names.
Boolean	convertDotsInJsonKeysToUnderscores() When set to true, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends OpenXJsonSerDe.Builder>	serializableBuilderClass()
OpenXJsonSerDe.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

convertDotsInJsonKeysToUnderscores

public Boolean convertDotsInJsonKeysToUnderscores()

When set to true, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.

The default is false.

Returns:

When set to true, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.

The default is false.

caseInsensitive

public Boolean caseInsensitive()

When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.

Returns:

When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.

columnToJsonKeyMappings

public Map<String,String> columnToJsonKeyMappings()

Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts.

toBuilder

public OpenXJsonSerDe.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<OpenXJsonSerDe.Builder,OpenXJsonSerDe>

Returns:

a builder for type T

builder

public static OpenXJsonSerDe.Builder builder()

serializableBuilderClass

public static Class<? extends OpenXJsonSerDe.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.