OpenXJsonSerDe (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisfirehose.model.OpenXJsonSerDe

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OpenXJsonSerDe
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OpenXJsonSerDe()

Constructors
Constructor and Description
`OpenXJsonSerDe()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OpenXJsonSerDe`	`addColumnToJsonKeyMappingsEntry(String key, String value)` Add a single ColumnToJsonKeyMappings entry
`OpenXJsonSerDe`	`clearColumnToJsonKeyMappingsEntries()` Removes all the entries added into ColumnToJsonKeyMappings.
`OpenXJsonSerDe`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCaseInsensitive()` When set to `true`, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
`Map<String,String>`	`getColumnToJsonKeyMappings()` Maps column names to JSON keys that aren't identical to the column names.
`Boolean`	`getConvertDotsInJsonKeysToUnderscores()` 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.
`int`	`hashCode()`
`Boolean`	`isCaseInsensitive()` When set to `true`, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
`Boolean`	`isConvertDotsInJsonKeysToUnderscores()` 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.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCaseInsensitive(Boolean caseInsensitive)` When set to `true`, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
`void`	`setColumnToJsonKeyMappings(Map<String,String> columnToJsonKeyMappings)` Maps column names to JSON keys that aren't identical to the column names.
`void`	`setConvertDotsInJsonKeysToUnderscores(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.
`String`	`toString()` Returns a string representation of this object.
`OpenXJsonSerDe`	`withCaseInsensitive(Boolean caseInsensitive)` When set to `true`, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
`OpenXJsonSerDe`	`withColumnToJsonKeyMappings(Map<String,String> columnToJsonKeyMappings)` Maps column names to JSON keys that aren't identical to the column names.
`OpenXJsonSerDe`	`withConvertDotsInJsonKeysToUnderscores(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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OpenXJsonSerDe
```
public OpenXJsonSerDe()
```
- Method Detail
  - setConvertDotsInJsonKeysToUnderscores
```
public void setConvertDotsInJsonKeysToUnderscores(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.
    
    Parameters:
    
    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.
  - getConvertDotsInJsonKeysToUnderscores
```
public Boolean getConvertDotsInJsonKeysToUnderscores()
```
    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.
  - withConvertDotsInJsonKeysToUnderscores
```
public OpenXJsonSerDe withConvertDotsInJsonKeysToUnderscores(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isConvertDotsInJsonKeysToUnderscores
```
public Boolean isConvertDotsInJsonKeysToUnderscores()
```
    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.
  - setCaseInsensitive
```
public void setCaseInsensitive(Boolean caseInsensitive)
```
    When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
    
    Parameters:
    
    caseInsensitive - When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
  - getCaseInsensitive
```
public Boolean getCaseInsensitive()
```
    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.
  - withCaseInsensitive
```
public OpenXJsonSerDe withCaseInsensitive(Boolean caseInsensitive)
```
    When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
    
    Parameters:
    
    caseInsensitive - When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCaseInsensitive
```
public Boolean isCaseInsensitive()
```
    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.
  - getColumnToJsonKeyMappings
```
public Map<String,String> getColumnToJsonKeyMappings()
```
    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.
    
    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.
  - setColumnToJsonKeyMappings
```
public void setColumnToJsonKeyMappings(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.
    
    Parameters:
    
    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.
  - withColumnToJsonKeyMappings
```
public OpenXJsonSerDe withColumnToJsonKeyMappings(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addColumnToJsonKeyMappingsEntry
```
public OpenXJsonSerDe addColumnToJsonKeyMappingsEntry(String key,
                                                      String value)
```
    Add a single ColumnToJsonKeyMappings entry
    
    See Also:
    
    withColumnToJsonKeyMappings(java.util.Map<java.lang.String, java.lang.String>)
  - clearColumnToJsonKeyMappingsEntries
```
public OpenXJsonSerDe clearColumnToJsonKeyMappingsEntries()
```
    Removes all the entries added into ColumnToJsonKeyMappings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public OpenXJsonSerDe clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class OpenXJsonSerDe

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OpenXJsonSerDe

Method Detail

setConvertDotsInJsonKeysToUnderscores

getConvertDotsInJsonKeysToUnderscores

withConvertDotsInJsonKeysToUnderscores

isConvertDotsInJsonKeysToUnderscores

setCaseInsensitive

getCaseInsensitive

withCaseInsensitive

isCaseInsensitive

getColumnToJsonKeyMappings

setColumnToJsonKeyMappings

withColumnToJsonKeyMappings

addColumnToJsonKeyMappingsEntry

clearColumnToJsonKeyMappingsEntries

toString

equals

hashCode

clone

marshall