Chapter 45. Protobuf Deserialize Action

Deserialize payload to Protobuf

45.1. Configuration Options

The following table summarizes the configuration options available for the protobuf-deserialize-action Kamelet:

PropertyNameDescriptionTypeDefaultExample

schema *

Schema

The Protobuf schema to use during serialization (as single-line)

string

 

"message Person { required string first = 1; required string last = 2; }"

Note

Fields marked with an asterisk (*) are mandatory.

45.2. Dependencies

At runtime, the protobuf-deserialize-action Kamelet relies upon the presence of the following dependencies:

  • github:openshift-integration.kamelet-catalog:camel-kamelets-utils:kamelet-catalog-1.6-SNAPSHOT
  • camel:kamelet
  • camel:core
  • camel:jackson-protobuf

45.3. Usage

This section describes how you can use the protobuf-deserialize-action.

45.3.1. Knative Action

You can use the protobuf-deserialize-action Kamelet as an intermediate step in a Knative binding.

protobuf-deserialize-action-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: protobuf-deserialize-action-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: timer-source
    properties:
      message: '{"first": "John", "last":"Doe"}'
  steps:
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: json-deserialize-action
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: protobuf-serialize-action
    properties:
      schema: "message Person { required string first = 1; required string last = 2; }"
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: protobuf-deserialize-action
    properties:
      schema: "message Person { required string first = 1; required string last = 2; }"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

45.3.1.1. Prerequisite

Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

45.3.1.2. Procedure for using the cluster CLI

  1. Save the protobuf-deserialize-action-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command: 

    oc apply -f protobuf-deserialize-action-binding.yaml

45.3.1.3. Procedure for using the Kamel CLI

Configure and run the action by using the following command: 

kamel bind --name protobuf-deserialize-action-binding timer-source?message='{"first":"John","last":"Doe"}' --step json-deserialize-action --step protobuf-serialize-action -p step-1.schema='message Person { required string first = 1; required string last = 2; }' --step protobuf-deserialize-action -p step-2.schema='message Person { required string first = 1; required string last = 2; }' channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

45.3.2. Kafka Action

You can use the protobuf-deserialize-action Kamelet as an intermediate step in a Kafka binding.

protobuf-deserialize-action-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: protobuf-deserialize-action-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: timer-source
    properties:
      message: '{"first": "John", "last":"Doe"}'
  steps:
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: json-deserialize-action
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: protobuf-serialize-action
    properties:
      schema: "message Person { required string first = 1; required string last = 2; }"
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: protobuf-deserialize-action
    properties:
      schema: "message Person { required string first = 1; required string last = 2; }"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

45.3.2.1. Prerequisites

Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

45.3.2.2. Procedure for using the cluster CLI

  1. Save the protobuf-deserialize-action-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command: 

    oc apply -f protobuf-deserialize-action-binding.yaml

45.3.2.3. Procedure for using the Kamel CLI

Configure and run the action by using the following command: 

kamel bind --name protobuf-deserialize-action-binding timer-source?message='{"first":"John","last":"Doe"}' --step json-deserialize-action --step protobuf-serialize-action -p step-1.schema='message Person { required string first = 1; required string last = 2; }' --step protobuf-deserialize-action -p step-2.schema='message Person { required string first = 1; required string last = 2; }' kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.

45.4. Kamelet source file

https://github.com/openshift-integration/kamelet-catalog/tree/kamelet-catalog-1.8//protobuf-deserialize-action.kamelet.yaml