You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::KinesisAnalytics::Types::SourceSchema

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb

Overview

Note:

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

{
  record_format: { # required
    record_format_type: "JSON", # required, accepts JSON, CSV
    mapping_parameters: {
      json_mapping_parameters: {
        record_row_path: "RecordRowPath", # required
      },
      csv_mapping_parameters: {
        record_row_delimiter: "RecordRowDelimiter", # required
        record_column_delimiter: "RecordColumnDelimiter", # required
      },
    },
  },
  record_encoding: "RecordEncoding",
  record_columns: [ # required
    {
      name: "RecordColumnName", # required
      mapping: "RecordColumnMapping",
      sql_type: "RecordColumnSqlType", # required
    },
  ],
}

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

Instance Attribute Summary collapse

Instance Attribute Details

#record_columnsArray<Types::RecordColumn>

A list of RecordColumn objects.

Returns:



2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2860

class SourceSchema < Struct.new(
  :record_format,
  :record_encoding,
  :record_columns)
  include Aws::Structure
end

#record_encodingString

Specifies the encoding of the records in the streaming source. For example, UTF-8.

Returns:

  • (String)


2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2860

class SourceSchema < Struct.new(
  :record_format,
  :record_encoding,
  :record_columns)
  include Aws::Structure
end

#record_formatTypes::RecordFormat

Specifies the format of the records on the streaming source.

Returns:



2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2860

class SourceSchema < Struct.new(
  :record_format,
  :record_encoding,
  :record_columns)
  include Aws::Structure
end