OpenSearch/docs/reference/ingest/processors/bytes.asciidoc

32 lines
1.1 KiB
Plaintext

[[bytes-processor]]
=== Bytes processor
++++
<titleabbrev>Bytes</titleabbrev>
++++
Converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). If the field is an array of strings, all members of the array will be converted.
Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if
the field is not a supported format or resultant value exceeds 2^63.
[[bytes-options]]
.Bytes Options
[options="header"]
|======
| Name | Required | Default | Description
| `field` | yes | - | The field to convert
| `target_field` | no | `field` | The field to assign the converted value to, by default `field` is updated in-place
| `ignore_missing` | no | `false` | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document
include::common-options.asciidoc[]
|======
[source,js]
--------------------------------------------------
{
"bytes": {
"field": "file.size"
}
}
--------------------------------------------------
// NOTCONSOLE