Chapter 21. Hoist Field Action

Wrap data in a single field

21.1. Configuration Options

The following table summarizes the configuration options available for the hoist-field-action Kamelet:

PropertyNameDescriptionTypeDefaultExample

field *

Field

The name of the field that will contain the event

string

  
Note

Fields marked with an asterisk (*) are mandatory.

21.2. Dependencies

At runtime, the hoist-field-action Kamelet relies upon the presence of the following dependencies:

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

21.3. Usage

This section describes how you can use the hoist-field-action.

21.3.1. Knative Action

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

hoist-field-action-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: hoist-field-action-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: timer-source
    properties:
      message: "Hello"
  steps:
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: hoist-field-action
    properties:
      field: "The Field"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

21.3.1.1. Prerequisite

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

21.3.1.2. Procedure for using the cluster CLI

  1. Save the hoist-field-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 hoist-field-action-binding.yaml

21.3.1.3. Procedure for using the Kamel CLI

Configure and run the action by using the following command: 

kamel bind timer-source?message=Hello --step hoist-field-action -p "step-0.field=The Field" channel:mychannel

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

21.3.2. Kafka Action

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

hoist-field-action-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: hoist-field-action-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: timer-source
    properties:
      message: "Hello"
  steps:
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: hoist-field-action
    properties:
      field: "The Field"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

21.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.

21.3.2.2. Procedure for using the cluster CLI

  1. Save the hoist-field-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 hoist-field-action-binding.yaml

21.3.2.3. Procedure for using the Kamel CLI

Configure and run the action by using the following command: 

kamel bind timer-source?message=Hello --step hoist-field-action -p "step-0.field=The Field" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

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

21.4. Kamelet source file

https://github.com/openshift-integration/kamelet-catalog/tree/kamelet-catalog-1.8//hoist-field-action.kamelet.yaml