Class: Aws::Firehose::Types::OpenXJsonSerDe

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-firehose/types.rb

Overview

Note:

When making an API call, you may pass OpenXJsonSerDe data as a hash:

{
  convert_dots_in_json_keys_to_underscores: false,
  case_insensitive: false,
  column_to_json_key_mappings: {
    "NonEmptyStringWithoutWhitespace" => "NonEmptyString",
  },
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#case_insensitiveBoolean

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

Returns:

  • (Boolean)

3691
3692
3693
3694
3695
3696
3697
# File 'lib/aws-sdk-firehose/types.rb', line 3691

class OpenXJsonSerDe < Struct.new(
  :convert_dots_in_json_keys_to_underscores,
  :case_insensitive,
  :column_to_json_key_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#column_to_json_key_mappingsHash<String,String>

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 `“timestamp”` to map this key to a column named `ts`.

Returns:

  • (Hash<String,String>)

3691
3692
3693
3694
3695
3696
3697
# File 'lib/aws-sdk-firehose/types.rb', line 3691

class OpenXJsonSerDe < Struct.new(
  :convert_dots_in_json_keys_to_underscores,
  :case_insensitive,
  :column_to_json_key_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#convert_dots_in_json_keys_to_underscoresBoolean

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:

  • (Boolean)

3691
3692
3693
3694
3695
3696
3697
# File 'lib/aws-sdk-firehose/types.rb', line 3691

class OpenXJsonSerDe < Struct.new(
  :convert_dots_in_json_keys_to_underscores,
  :case_insensitive,
  :column_to_json_key_mappings)
  SENSITIVE = []
  include Aws::Structure
end