Parameter | Description |
payload_field | The payload field. For example, if the event to be analyzed has been placed in the event variable ev, then its payload field would conventionally be ev.__payload. |
field_name | The name of the field to extract from the payload. This parameter takes a string literal. |
default_value | The value to return if the field specified in field_name does not exist, has no value (is empty or null), is invalid (e.g. contains binary characters) or cannot be cast to the type requested. The type of this parameter depends on the particular method; it is a string for parseString, a float for parseFloat, an integer for parseInteger, and a boolean for parseBoolean. Note that all types can be cast to a string, however, the opposite might not be possible. For example a string can be only be successfully cast to a float if it contains a valid float number, for example, 1.0. |