vrl 0.32.0

Vector Remap Language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

{
  "anchor": "parse_yaml",
  "name": "parse_yaml",
  "category": "Parse",
  "description": "Parses the provided `value` as YAML.\n\nOnly YAML types are returned. If you need to convert a `string` into a `timestamp`,\nconsider the `parse_timestamp` function.",
  "arguments": [
    {
      "name": "value",
      "description": "The string representation of the YAML to parse.",
      "required": true,
      "type": [
        "string"
      ]
    }
  ],
  "return": {
    "types": [
      "string",
      "integer",
      "float",
      "boolean",
      "object",
      "array",
      "null"
    ]
  },
  "internal_failure_reasons": [
    "`value` is not a valid YAML-formatted payload."
  ],
  "examples": [
    {
      "title": "Parse simple YAML",
      "source": "parse_yaml!(s'key: val')",
      "return": {
        "key": "val"
      }
    },
    {
      "title": "Parse YAML",
      "source": "parse_yaml!(s'\n                    object:\n                        string: value\n                        number: 42\n                        boolean: false\n                        array:\n                        - hello\n                        - world\n                        json_array: [\"hello\", \"world\"]\n                ')",
      "return": {
        "object": {
          "string": "value",
          "number": 42,
          "boolean": false,
          "array": [
            "hello",
            "world"
          ],
          "json_array": [
            "hello",
            "world"
          ]
        }
      }
    },
    {
      "title": "Parse YAML string",
      "source": "parse_yaml!(s'hello')",
      "return": "hello"
    },
    {
      "title": "Parse YAML quoted string",
      "source": "parse_yaml!(s'\"hello\"')",
      "return": "hello"
    },
    {
      "title": "Parse YAML integer",
      "source": "parse_yaml!(\"42\")",
      "return": 42
    },
    {
      "title": "Parse YAML float",
      "source": "parse_yaml!(\"42.13\")",
      "return": 42.13
    },
    {
      "title": "Parse YAML boolean",
      "source": "parse_yaml!(\"false\")",
      "return": false
    },
    {
      "title": "Parse embedded JSON",
      "source": "parse_yaml!(s'{\"key\": \"val\"}')",
      "return": {
        "key": "val"
      }
    },
    {
      "title": "Parse embedded JSON array",
      "source": "parse_yaml!(\"[true, 0]\")",
      "return": [
        true,
        0
      ]
    }
  ],
  "notices": [
    "Only YAML types are returned. If you need to convert a `string` into a `timestamp`,\nconsider the [`parse_timestamp`](#parse_timestamp) function."
  ],
  "pure": true
}