Class: AWSCDK::KinesisFirehose::TimestampParser

Inherits:
Jsii::Object
  • Object
show all
Defined in:
kinesis_firehose/timestamp_parser.rb

Overview

Value class that wraps a Joda Time format string.

Use this with the Hive JSON input format for data record format conversion to parse custom timestamp formats.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ TimestampParser

Returns a new instance of TimestampParser.

Raises:

  • (NoMethodError)


10
11
12
# File 'kinesis_firehose/timestamp_parser.rb', line 10

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_kinesisfirehose.TimestampParser does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.EPOCH_MILLISAWSCDK::KinesisFirehose::TimestampParser

Parses timestamps formatted in milliseconds since epoch.

Returns:

  • (AWSCDK::KinesisFirehose::TimestampParser)


35
36
37
# File 'kinesis_firehose/timestamp_parser.rb', line 35

def self.EPOCH_MILLIS()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_kinesisfirehose.TimestampParser", "EPOCH_MILLIS")
end

.from_format_string(format) ⇒ AWSCDK::KinesisFirehose::TimestampParser

Creates a TimestampParser from the given format string.

The format string should be a valid Joda Time pattern string. See Class DateTimeFormat for more details

Parameters:

  • format (String)

    the Joda Time format string.

Returns:

  • (AWSCDK::KinesisFirehose::TimestampParser)


27
28
29
30
# File 'kinesis_firehose/timestamp_parser.rb', line 27

def self.from_format_string(format)
  Jsii::Type.check_type(format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "format")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kinesisfirehose.TimestampParser", "fromFormatString", [format])
end

.jsii_overridable_methodsObject



14
15
16
17
18
# File 'kinesis_firehose/timestamp_parser.rb', line 14

def self.jsii_overridable_methods
  {
    :format => { kind: :property, name: "format", is_optional: false },
  }
end

Instance Method Details

#formatString

The format string to use in Hive JSON input format configuration.

Returns:

  • (String)


42
43
44
# File 'kinesis_firehose/timestamp_parser.rb', line 42

def format()
  jsii_get_property("format")
end