PUT
/
transforms
Update Transform
curl --request PUT \
  --url https://api.streamkap.com/transforms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "transform": "fan_out",
  "config": {
    "transforms.name": "<string>",
    "transforms.language": "<string>",
    "transforms.input.topic.pattern": "<string>",
    "transforms.output.topic.pattern": "<string>",
    "transforms.input.serialization.format": "Any",
    "transforms.output.serialization.format": "Any",
    "transforms.input.job.parallelism": 5
  },
  "created_from": "terraform",
  "id": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "sub_id": "<string>",
  "tenant_id": "<string>",
  "service_id": "<string>",
  "start_time": "<string>",
  "job_name": "<string>",
  "topic_ids": "<string>",
  "transform_type": "fan_out",
  "config": {
    "transforms.name": "<string>",
    "transforms.language": "<string>",
    "transforms.input.topic.pattern": "<string>",
    "transforms.output.topic.pattern": "<string>",
    "transforms.input.serialization.format": "Any",
    "transforms.output.serialization.format": "Any",
    "transforms.input.job.parallelism": 5
  },
  "implementation": {
    "language": "PYTHON",
    "value_transform": "<string>",
    "key_transform": "<string>",
    "topic_transform": "<string>",
    "unit_test": {
      "test_name": "<string>",
      "input__json": [
        {
          "topic": "<string>",
          "value": {},
          "key": {},
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "output__json": [
        {
          "topic": "<string>",
          "value": {},
          "key": {},
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "result__json": [
        {
          "topic": "<string>",
          "value": {},
          "key": {},
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "is_success": true,
      "html_diff": "<string>",
      "text_diff": "<string>"
    }
  },
  "metrics": {
    "tasks": 123,
    "latency": 123,
    "status": "<string>",
    "duration": 123,
    "start_time": 123,
    "end_time": "<string>"
  },
  "live_version": "<string>",
  "preview_version": "<string>",
  "version": 1,
  "updated_timestamp": "2023-11-07T05:31:56Z",
  "implementation_updated_timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
transform
enum<string>
required
Available options:
fan_out,
sql_join,
enrich,
enrich_async,
map_filter,
toast_handling,
un_nesting
config
object
required
id
string
required
created_from
enum<string> | null
default:api
Available options:
terraform,
web,
api

Response

Successful Response

Basic transform details.

id
string
required
name
string
required
sub_id
string
required
tenant_id
string
required
transform_type
enum<string>
required
Available options:
fan_out,
sql_join,
enrich,
enrich_async,
map_filter,
toast_handling,
un_nesting
config
object
required
service_id
string | null
start_time
job_name
string | null
topic_ids
string | null
implementation
object | null
metrics
object | null
live_version
string | null
preview_version
string | null
version
integer
default:1
updated_timestamp
string<date-time> | null
implementation_updated_timestamp
string<date-time> | null