Streams
The stream payload is made up of a name, specification, and an optional configSelector node.
Node | Necessity | Description |
|---|---|---|
name | required | Represents the name of the underlying Apache Kafka® topic. |
spec.kind | required | The definition of the underlying streaming technology. As of now, only Apache Kafka is oficially supported by DataCater. |
spec.kafka | required | Contains the connection information to the Apache Kafka® cluster. |
spec.topic | optional | Contains the configuration for the underlying Apache Kafka® topic. This node resides inside the specification-node. |
configSelector | optional | For referencing config objects. |
{
"name": "stream-name",
"spec": {
"kafka": {
"bootstrap.servers": "localhost:9092",
"topic": {
"num.partitions": "4",
"replication.factor": "1"
}
}
},
"kind": "KAFKA"
},
"configSelector": {
"configKey": "configValue"
}
}
Get all streams.
get
/api/v1/streams
Get a specific stream identified by its uuid.
get
/api/v1/streams/{uuid}
Create a new stream.
post
/api/v1/streams
Update a specific stream identified by its uuid.
put
/api/v1/streams/{uuid}
Delete a specific stream identified by its uuid.
delete
/api/v1/streams/{uuid}
Inspect the content of a stream identified by its uuid and get the most recent records of the underlying Apache Kafka topic. The number of retrieved records can be defined by the parameter
limit (default: 100).Each record consists of a
key, a value, and additional metadata.get
/api/v1/streams/{uuid}/inspect
Last modified 20d ago