AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Firehose::Model::OpenXJsonSerDe Class Reference

#include <OpenXJsonSerDe.h>

Public Member Functions

 OpenXJsonSerDe ()
 
 OpenXJsonSerDe (Aws::Utils::Json::JsonView jsonValue)
 
OpenXJsonSerDeoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetConvertDotsInJsonKeysToUnderscores () const
 
bool ConvertDotsInJsonKeysToUnderscoresHasBeenSet () const
 
void SetConvertDotsInJsonKeysToUnderscores (bool value)
 
OpenXJsonSerDeWithConvertDotsInJsonKeysToUnderscores (bool value)
 
bool GetCaseInsensitive () const
 
bool CaseInsensitiveHasBeenSet () const
 
void SetCaseInsensitive (bool value)
 
OpenXJsonSerDeWithCaseInsensitive (bool value)
 
const Aws::Map< Aws::String, Aws::String > & GetColumnToJsonKeyMappings () const
 
bool ColumnToJsonKeyMappingsHasBeenSet () const
 
void SetColumnToJsonKeyMappings (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetColumnToJsonKeyMappings (Aws::Map< Aws::String, Aws::String > &&value)
 
OpenXJsonSerDeWithColumnToJsonKeyMappings (const Aws::Map< Aws::String, Aws::String > &value)
 
OpenXJsonSerDeWithColumnToJsonKeyMappings (Aws::Map< Aws::String, Aws::String > &&value)
 
OpenXJsonSerDeAddColumnToJsonKeyMappings (const Aws::String &key, const Aws::String &value)
 
OpenXJsonSerDeAddColumnToJsonKeyMappings (Aws::String &&key, const Aws::String &value)
 
OpenXJsonSerDeAddColumnToJsonKeyMappings (const Aws::String &key, Aws::String &&value)
 
OpenXJsonSerDeAddColumnToJsonKeyMappings (Aws::String &&key, Aws::String &&value)
 
OpenXJsonSerDeAddColumnToJsonKeyMappings (const char *key, Aws::String &&value)
 
OpenXJsonSerDeAddColumnToJsonKeyMappings (Aws::String &&key, const char *value)
 
OpenXJsonSerDeAddColumnToJsonKeyMappings (const char *key, const char *value)
 

Detailed Description

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 Reference

Definition at line 36 of file OpenXJsonSerDe.h.

Constructor & Destructor Documentation

◆ OpenXJsonSerDe() [1/2]

Aws::Firehose::Model::OpenXJsonSerDe::OpenXJsonSerDe ( )

◆ OpenXJsonSerDe() [2/2]

Aws::Firehose::Model::OpenXJsonSerDe::OpenXJsonSerDe ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddColumnToJsonKeyMappings() [1/7]

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::AddColumnToJsonKeyMappings ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 172 of file OpenXJsonSerDe.h.

◆ AddColumnToJsonKeyMappings() [2/7]

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::AddColumnToJsonKeyMappings ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 181 of file OpenXJsonSerDe.h.

◆ AddColumnToJsonKeyMappings() [3/7]

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::AddColumnToJsonKeyMappings ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 190 of file OpenXJsonSerDe.h.

◆ AddColumnToJsonKeyMappings() [4/7]

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::AddColumnToJsonKeyMappings ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 199 of file OpenXJsonSerDe.h.

◆ AddColumnToJsonKeyMappings() [5/7]

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::AddColumnToJsonKeyMappings ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 208 of file OpenXJsonSerDe.h.

◆ AddColumnToJsonKeyMappings() [6/7]

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::AddColumnToJsonKeyMappings ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 217 of file OpenXJsonSerDe.h.

◆ AddColumnToJsonKeyMappings() [7/7]

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::AddColumnToJsonKeyMappings ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 226 of file OpenXJsonSerDe.h.

◆ CaseInsensitiveHasBeenSet()

bool Aws::Firehose::Model::OpenXJsonSerDe::CaseInsensitiveHasBeenSet ( ) const
inline

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

Definition at line 96 of file OpenXJsonSerDe.h.

◆ ColumnToJsonKeyMappingsHasBeenSet()

bool Aws::Firehose::Model::OpenXJsonSerDe::ColumnToJsonKeyMappingsHasBeenSet ( ) const
inline

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.

Definition at line 127 of file OpenXJsonSerDe.h.

◆ ConvertDotsInJsonKeysToUnderscoresHasBeenSet()

bool Aws::Firehose::Model::OpenXJsonSerDe::ConvertDotsInJsonKeysToUnderscoresHasBeenSet ( ) const
inline

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.

Definition at line 63 of file OpenXJsonSerDe.h.

◆ GetCaseInsensitive()

bool Aws::Firehose::Model::OpenXJsonSerDe::GetCaseInsensitive ( ) const
inline

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

Definition at line 90 of file OpenXJsonSerDe.h.

◆ GetColumnToJsonKeyMappings()

const Aws::Map<Aws::String, Aws::String>& Aws::Firehose::Model::OpenXJsonSerDe::GetColumnToJsonKeyMappings ( ) const
inline

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.

Definition at line 118 of file OpenXJsonSerDe.h.

◆ GetConvertDotsInJsonKeysToUnderscores()

bool Aws::Firehose::Model::OpenXJsonSerDe::GetConvertDotsInJsonKeysToUnderscores ( ) const
inline

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.

Definition at line 53 of file OpenXJsonSerDe.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Firehose::Model::OpenXJsonSerDe::Jsonize ( ) const

◆ operator=()

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCaseInsensitive()

void Aws::Firehose::Model::OpenXJsonSerDe::SetCaseInsensitive ( bool  value)
inline

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

Definition at line 102 of file OpenXJsonSerDe.h.

◆ SetColumnToJsonKeyMappings() [1/2]

void Aws::Firehose::Model::OpenXJsonSerDe::SetColumnToJsonKeyMappings ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 136 of file OpenXJsonSerDe.h.

◆ SetColumnToJsonKeyMappings() [2/2]

void Aws::Firehose::Model::OpenXJsonSerDe::SetColumnToJsonKeyMappings ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 145 of file OpenXJsonSerDe.h.

◆ SetConvertDotsInJsonKeysToUnderscores()

void Aws::Firehose::Model::OpenXJsonSerDe::SetConvertDotsInJsonKeysToUnderscores ( bool  value)
inline

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.

Definition at line 73 of file OpenXJsonSerDe.h.

◆ WithCaseInsensitive()

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::WithCaseInsensitive ( bool  value)
inline

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

Definition at line 108 of file OpenXJsonSerDe.h.

◆ WithColumnToJsonKeyMappings() [1/2]

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::WithColumnToJsonKeyMappings ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 154 of file OpenXJsonSerDe.h.

◆ WithColumnToJsonKeyMappings() [2/2]

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::WithColumnToJsonKeyMappings ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 163 of file OpenXJsonSerDe.h.

◆ WithConvertDotsInJsonKeysToUnderscores()

OpenXJsonSerDe& Aws::Firehose::Model::OpenXJsonSerDe::WithConvertDotsInJsonKeysToUnderscores ( bool  value)
inline

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.

Definition at line 83 of file OpenXJsonSerDe.h.


The documentation for this class was generated from the following file: