hoist field action Hoist Field Action

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Wrap data in a single field

Configuration Options

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

Property Name Description Type Default Example

field *

Field

The name of the field that will contain the event

string

Fields marked with an asterisk (*) are mandatory.

Dependencies

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

  • github:apache.camel-kamelets:camel-kamelets-utils:main-SNAPSHOT

  • camel:core

  • camel:jackson

  • camel:kamelet

Usage

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

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

Prerequisite

You have Camel K installed on the cluster.

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:

    kubectl apply -f hoist-field-action-binding.yaml

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.

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

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

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:

    kubectl apply -f hoist-field-action-binding.yaml

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.