Data connectors

Register, list, detail and unregister data sources and sinks

Overview

Transports provide the integration links required to consume and publish computed stream results. Joule Management API provides the ability to register, list, detail and undeploy transports.

For further information on the structure of the content payload refer to this documentation.

Example data connector content

{
    "kafkaConsumer": {
        "name": "nasdaq_quotes_stream",
        "cluster address": "joule-gs-redpanda-0:9092",
        "consumerGroupId": "nasdaq",
        "topics": [
        "quotes"
        ],
        "deserializer": {
        "parser": "com.fractalworks.examples.banking.data.QuoteToStreamEventParser",
        "key deserializer": "org.apache.kafka.common.serialization.IntegerDeserializer",
        "value deserializer": "com.fractalworks.streams.transport.kafka.serializers.object.ObjectDeserializer"
        },
        "properties": {
        "partition.assignment.strategy": "org.apache.kafka.clients.consumer.StickyAssignor",
        "max.poll.records" : "7000",
        "fetch.max.bytes" : "10485760"
        }
    }
}

Register transport

post

Register transport that either consumes or publishes data. A json definition is provided within the body as a raw data typeIf the registration process has succeed a response code of 201 is returned otherwise 500.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/joule/management/transports/register'

201

500

501

502

503

201

No body

Successful registered transport

List transports by type

get

Query parameters

typestringrequired

Transport type (i.e. SINK, SOURCE, REFERENCE_DATA)

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/joule/management/transports/list?type=text'

404

500

501

404

No body

Failed to find transport using provided name.

Get transport specification

get

Query parameters

namestringrequired

Use case DSL configuration.

typestringrequired

Transport type (i.e. SINK, SOURCE, REFERENCE_DATA)

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/joule/management/transports/detail?name=text&type=text'

200

404

501

200

No body

Provide the transport specification

Unregister transport

delete

Unregister transport that either consumes or publishes data.If the unregistion process has succeed a response code of 201 is returned.

Query parameters

namestringrequired

Transport logical name.

typestringrequired

Transport type (i.e. SINK, SOURCE, REFERENCE_DATA)

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/joule/management/transports/unregister?name=text&type=text'

201

500

501

502

503

201

No body

Successful transport unregister