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

{
  "anchor": "parse_proto",
  "name": "parse_proto",
  "category": "Parse",
  "description": "Parses the `value` as a protocol buffer payload.",
  "arguments": [
    {
      "name": "value",
      "description": "The protocol buffer payload to parse.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "desc_file",
      "description": "The path to the protobuf descriptor set file. Must be a literal string.\n\nThis file is the output of protoc -o <path> ...",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "message_type",
      "description": "The name of the message type to use for serializing.\n\nMust be a literal string.",
      "required": true,
      "type": [
        "string"
      ]
    }
  ],
  "return": {
    "types": [
      "object"
    ]
  },
  "internal_failure_reasons": [
    "`value` is not a valid proto payload.",
    "`desc_file` file does not exist.",
    "`message_type` message type does not exist in the descriptor file."
  ],
  "examples": [
    {
      "title": "Parse proto",
      "source": "parse_proto!(decode_base64!(\"Cgdzb21lb25lIggKBjEyMzQ1Ng==\"), \"tests/data/protobuf/test_protobuf/v1/test_protobuf.desc\", \"test_protobuf.v1.Person\")",
      "return": {
        "name": "someone",
        "phones": [
          {
            "number": "123456"
          }
        ]
      }
    }
  ],
  "notices": [
    "Only proto messages are parsed and returned."
  ],
  "pure": true
}