Cast¶

This formatter casts a given metadata filed into another type.

AsType: The type to cast to. Can be either string, bytes, float or int.

By default this parameter is set to “string”.

Parameters¶

ToType (default: string)

(no documentation available)

Parameters (from core.SimpleFormatter)¶

Source

This value chooses the part of the message the data to be formatted should be read from. Use “” to target the message payload; other values specify the name of a metadata field to target. By default this parameter is set to “”.

Target

This value chooses the part of the message the formatted data should be stored to. Use “” to target the message payload; other values specify the name of a metadata field to target. By default this parameter is set to “”.

ApplyTo

Use this to set Source and Target to the same value. This setting will be ignored if either Source or Target is set to something else but “”. By default this parameter is set to “”.

SkipIfEmpty

When set to true, this formatter will not be applied to data that is empty or - in case of metadata - not existing. By default this parameter is set to false

Examples¶

This example casts the key “bar” to string.

exampleConsumer:
  Type: consumer.Console
  Streams: stdin
  Modulators:
    - format.Cast
      ApplyTo: bar
      ToType: "string"