Protobuf to JSON

Description

This operation converts events in Protobuf (Protocol Buffers) format into JSON. Protocol Buffers is a language-neutral, platform-neutral, extensible mechanism for serializing structured data. It's similar to JSON, but smaller and faster.

---

Data types

These are the input/output expected data types for this operation:

Input data

- Protobuf-formatted strings you want to transform into JSON. These must be encoded in Base64 format. You can use the To Base64 operation to transform your input strings.

Output data

- Resulting JSON-formatted strings.

---

Parameters

These are the parameters you need to configure to use this operation (mandatory parameters are marked with a *):

Proto file*

The proto file is the file that defines the message structure of the data you want to transform into JSON. Note that these must be formatted in Base64 or as plain text. You can use the To Base64 operation to transform your input strings.

A common proto file has this structure:

syntax = "proto3";

message User {
  string username = 1;
  int32 age = 2;
}

Message type*

Enter the specific part of the message in the proto file that you want to transform into JSON format.

For example, in this proto file:

syntax = "proto3";

package company;

message Employee {
  int32 id = 1;
  string name = 2;
  string role = 3;
}

message Department {
  string name = 1;
  repeated Employee employees = 2;
}

Enter Employee or Department to extract one of the messages.

Example

Suppose you want to transform your Protobuf files into JSON. To do it:

1. In your Pipeline, open the required Action configuration and select the input Field.

2. In the Operation field, choose Protobuf to JSON.

3. In the Proto schema field, enter syntax = "proto3"; message ExampleMessage { int32 id = 1; string name = 2; }

4. In the Message type field, enter ExampleMessage

5. Give your Output field a name and click Save. Your Protobuf files will be transformed. For example:

CAESA2Zvbw== -> { "id": 1, "name": "foo" }

You can try out operations with specific values using the Input field above the operation. You can enter the value in the example above and check the result in the Output field.