REST API Reference

Back Next

Configuration information in the config array for Kafka as a source and as a target

The response returns only the fields that you entered in the request.

If the request is successful, the response returns the following fields:

Key	Type	Description
Topic	String	Kafka source topic name or a Java supported regular expression for the Kafka source topic name pattern to read the events from.
consumerProperties	String	A comma-separated list of optional consumer configuration properties.
producerProperties	String	The configuration properties for the producer.
mdFetchTimeout	Integer	The time after which the metadata is not fetched.
batchSize	Integer	The batch size of the events after which a streaming ingestion task writes data to the target.
Topic Name/Expression	String	Kafka topic name or a Java supported regular expression for the Kafka topic name pattern.

If the request is unsuccessful, the response includes a reason for the failure.

POST response example

If the request is successful, you might receive a response similar to the following example in a

Success

node:

{
  "Success": {
    "name": "kafka to kafka",
    "description": "kafka to kafka",
    "runtimeId": "01000025000000000003",
    "locationId": "5sJ0JDyJyWLlrosS5qJjsQ",
    "currentVersion": "2",
    "messageFormat": "binary",
    "nodes": [
      {
        "name": "kafka to kafka_source",
        "type": "source",
        "connectionId": "012MGS0B000000000002",
        "transformationType": "",
        "config": [
          {
            "key": "consumerProperties",
            "value": "key=value"
          },
          {
            "key": "Topic",
            "value": "test"
          }
        ]
      },
      {
        "name": "kafka to kafka_target",
        "type": "target",
        "connectionId": "012MGS0B000000000002",
        "transformationType": "",
        "config": [
          {
            "key": "producerProperties",
            "value": "key=value"
          },
          {
            "key": "mdFetchTimeout",
            "value": 5000
          },
          {
            "key": "batchSize",
            "value": 1048576
          },
          {
            "key": "Topic Name/Expression",
            "value": "test"
          }
        ]
      }
    ],
    "edges": [
      {
        "from": "kafka to kafka_source",
        "to": "kafka to kafka_target"
      }
    ]
  }
}

POST response

Download Guide

Watch

Comments

Cloud Data Integration Homepage