Create New Transform With Full Process
POST
/transforms/full-processAuthorization
AuthorizationBearer token · headerrequiredQuery parameters
secret_returnedbooleanWhether to include secret values in the response
default: false
replay_windowstringdefault: ""
Request body
requiredapplication/jsontransformTransformsLibraryEnumrequiredAllowed:
fan_outsql_joinenrichenrich_asyncmap_filtertoast_handlingun_nestingrolluptopic_routerconfigTransformConfigrequiredShow propertiesHide properties
transforms.namestringrequiredtransforms.languagestring | anyShow propertiesHide properties
Any of:
string
stringany
anytransforms.input.topic.patternstringrequiredtransforms.output.topic.patternstringrequiredtransforms.input.serialization.formatTransformSerializationFormatEnumrequiredAllowed:
AnyJsonAvrotransforms.output.serialization.formatTransformSerializationFormatEnumrequiredAllowed:
AnyJsonAvrotransforms.input.job.parallelismintegerdefault: 5
transforms.topic.ttlstring | anyShow propertiesHide properties
Any of:
string
stringany
anykc.cluster.idstring | anyShow propertiesHide properties
Any of:
string
stringany
anycreated_fromEntityOriginEnum | anydefault: "api"
Show propertiesHide properties
Any of:
EntityOriginEnum
stringany
anytagsstring[] | anyList of tag IDs to assign to this transform
Show propertiesHide properties
Any of:
string[]
Array of
stringstringany
anyimplementationTransformsMapFilterImplementation | TransformsEnrichImplementation | TransformsEnrichAsyncImplementation | TransformsJoinImplementation | TransformsRollupImplementationrequiredShow propertiesHide properties
Any of:
TransformsMapFilterImplementation
languageTransformLanguageEnumrequiredAllowed:
PYTHONJAVASCRIPTSQLvalue_transformstringrequiredkey_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anytopic_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anycommon_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anyvalue_schema_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anykey_schema_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anyunit_testTransformsUnitTest | anyShow propertiesHide properties
Any of:
TransformsUnitTest
test_namestringrequiredinput__jsonTransformsImplementationDetailsTestRecord[]requiredShow propertiesHide properties
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyoutput__jsonTransformsImplementationDetailsTestRecord[]requiredShow propertiesHide properties
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyresult__jsonTransformsImplementationDetailsTestRecord[] | anyShow propertiesHide properties
Any of:
TransformsImplementationDetailsTestRecord[]
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyany
anyis_successboolean | anyShow propertiesHide properties
Any of:
boolean
booleanany
anyhtml_diffstring | anyShow propertiesHide properties
Any of:
string
stringany
anytext_diffstring | anyShow propertiesHide properties
Any of:
string
stringany
anyany
anyTransformsEnrichImplementation
mainTableTransformInputTablerequiredShow propertiesHide properties
namestringrequiredtopicMatcherRegexstringrequiredcreateTableSQLstring | anyShow propertiesHide properties
Any of:
string
stringany
anylookupTableTransformInputTablerequiredShow propertiesHide properties
namestringrequiredtopicMatcherRegexstringrequiredcreateTableSQLstring | anyShow propertiesHide properties
Any of:
string
stringany
anyenrichSQLstringrequiredTransformsEnrichAsyncImplementation
languageTransformLanguageEnumrequiredAllowed:
PYTHONJAVASCRIPTSQLvalue_transformstringrequiredkey_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anytopic_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anycommon_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anyvalue_schema_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anykey_schema_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anyunit_testTransformsUnitTest | anyShow propertiesHide properties
Any of:
TransformsUnitTest
test_namestringrequiredinput__jsonTransformsImplementationDetailsTestRecord[]requiredShow propertiesHide properties
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyoutput__jsonTransformsImplementationDetailsTestRecord[]requiredShow propertiesHide properties
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyresult__jsonTransformsImplementationDetailsTestRecord[] | anyShow propertiesHide properties
Any of:
TransformsImplementationDetailsTestRecord[]
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyany
anyis_successboolean | anyShow propertiesHide properties
Any of:
boolean
booleanany
anyhtml_diffstring | anyShow propertiesHide properties
Any of:
string
stringany
anytext_diffstring | anyShow propertiesHide properties
Any of:
string
stringany
anyany
anyasync_timeout_msintegerdefault: 2000
async_capacityintegerdefault: 10
TransformsJoinImplementation
inputTablesTransformInputTable[]Show propertiesHide properties
Array of
TransformInputTablenamestringrequiredtopicMatcherRegexstringrequiredcreateTableSQLstring | anyShow propertiesHide properties
Any of:
string
stringany
anyjoinSQLstringrequiredkeyFieldsstring[]stateTtlMsstring | anyShow propertiesHide properties
Any of:
string
stringany
anyTransformsRollupImplementation
inputTablesTransformInputTable[]Show propertiesHide properties
Array of
TransformInputTablenamestringrequiredtopicMatcherRegexstringrequiredcreateTableSQLstring | anyShow propertiesHide properties
Any of:
string
stringany
anyrollupSQLstringrequiredkeyFieldsstring[]sourceIdleTimeoutMsintegerdefault: 30000
stateTTLMsintegerdefault: 86400000
Responses
200
Successful Response
idstringrequirednamestringrequiredsub_idstringrequiredtenant_idstringrequiredservice_idstring | anyShow propertiesHide properties
Any of:
string
stringany
anystart_timestring | string<date-time> | anyShow propertiesHide properties
Any of:
string
stringstring<date-time>
string<date-time>any
anyjob_namestring | anyShow propertiesHide properties
Any of:
string
stringany
anytopic_idsstring[] | string | anyShow propertiesHide properties
Any of:
string[]
Array of
stringstringstring
stringany
anytransform_typeTransformsLibraryEnumrequiredAllowed:
fan_outsql_joinenrichenrich_asyncmap_filtertoast_handlingun_nestingrolluptopic_routerconfigTransformConfig | TransformsEnrichAsyncConfig | anyShow propertiesHide properties
Any of:
TransformConfig
transforms.namestringrequiredtransforms.languagestring | anyShow propertiesHide properties
Any of:
string
stringany
anytransforms.input.topic.patternstringrequiredtransforms.output.topic.patternstringrequiredtransforms.input.serialization.formatTransformSerializationFormatEnumrequiredAllowed:
AnyJsonAvrotransforms.output.serialization.formatTransformSerializationFormatEnumrequiredAllowed:
AnyJsonAvrotransforms.input.job.parallelismintegerdefault: 5
transforms.topic.ttlstring | anyShow propertiesHide properties
Any of:
string
stringany
anykc.cluster.idstring | anyShow propertiesHide properties
Any of:
string
stringany
anyTransformsEnrichAsyncConfig
transforms.namestringrequiredtransforms.languagestring | anyShow propertiesHide properties
Any of:
string
stringany
anytransforms.input.topic.patternstringrequiredtransforms.output.topic.patternstringrequiredtransforms.input.serialization.formatTransformSerializationFormatEnumrequiredAllowed:
AnyJsonAvrotransforms.output.serialization.formatTransformSerializationFormatEnumrequiredAllowed:
AnyJsonAvrotransforms.input.job.parallelismintegerdefault: 5
transforms.topic.ttlstring | anyShow propertiesHide properties
Any of:
string
stringany
anykc.cluster.idstring | anyShow propertiesHide properties
Any of:
string
stringany
anytransforms.async.timeout.msintegerdefault: 1000
transforms.async.capacityintegerdefault: 10
any
anyimplementationTransformsMapFilterImplementation | TransformsEnrichImplementation | TransformsEnrichAsyncImplementation | TransformsJoinImplementation | TransformsRollupImplementation | TransformsTopicRouterImplementation | anyShow propertiesHide properties
Any of:
TransformsMapFilterImplementation
languageTransformLanguageEnumrequiredAllowed:
PYTHONJAVASCRIPTSQLvalue_transformstringrequiredkey_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anytopic_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anycommon_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anyvalue_schema_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anykey_schema_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anyunit_testTransformsUnitTest | anyShow propertiesHide properties
Any of:
TransformsUnitTest
test_namestringrequiredinput__jsonTransformsImplementationDetailsTestRecord[]requiredShow propertiesHide properties
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyoutput__jsonTransformsImplementationDetailsTestRecord[]requiredShow propertiesHide properties
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyresult__jsonTransformsImplementationDetailsTestRecord[] | anyShow propertiesHide properties
Any of:
TransformsImplementationDetailsTestRecord[]
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyany
anyis_successboolean | anyShow propertiesHide properties
Any of:
boolean
booleanany
anyhtml_diffstring | anyShow propertiesHide properties
Any of:
string
stringany
anytext_diffstring | anyShow propertiesHide properties
Any of:
string
stringany
anyany
anyTransformsEnrichImplementation
mainTableTransformInputTablerequiredShow propertiesHide properties
namestringrequiredtopicMatcherRegexstringrequiredcreateTableSQLstring | anyShow propertiesHide properties
Any of:
string
stringany
anylookupTableTransformInputTablerequiredShow propertiesHide properties
namestringrequiredtopicMatcherRegexstringrequiredcreateTableSQLstring | anyShow propertiesHide properties
Any of:
string
stringany
anyenrichSQLstringrequiredTransformsEnrichAsyncImplementation
languageTransformLanguageEnumrequiredAllowed:
PYTHONJAVASCRIPTSQLvalue_transformstringrequiredkey_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anytopic_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anycommon_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anyvalue_schema_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anykey_schema_transformstring | anyShow propertiesHide properties
Any of:
string
stringany
anyunit_testTransformsUnitTest | anyShow propertiesHide properties
Any of:
TransformsUnitTest
test_namestringrequiredinput__jsonTransformsImplementationDetailsTestRecord[]requiredShow propertiesHide properties
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyoutput__jsonTransformsImplementationDetailsTestRecord[]requiredShow propertiesHide properties
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyresult__jsonTransformsImplementationDetailsTestRecord[] | anyShow propertiesHide properties
Any of:
TransformsImplementationDetailsTestRecord[]
Array of
TransformsImplementationDetailsTestRecordtopicstringrequiredvalueobjectrequiredkeyobject | anyShow propertiesHide properties
Any of:
object
objectany
anytimestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyany
anyis_successboolean | anyShow propertiesHide properties
Any of:
boolean
booleanany
anyhtml_diffstring | anyShow propertiesHide properties
Any of:
string
stringany
anytext_diffstring | anyShow propertiesHide properties
Any of:
string
stringany
anyany
anyasync_timeout_msintegerdefault: 2000
async_capacityintegerdefault: 10
TransformsJoinImplementation
inputTablesTransformInputTable[]Show propertiesHide properties
Array of
TransformInputTablenamestringrequiredtopicMatcherRegexstringrequiredcreateTableSQLstring | anyShow propertiesHide properties
Any of:
string
stringany
anyjoinSQLstringrequiredkeyFieldsstring[]stateTtlMsstring | anyShow propertiesHide properties
Any of:
string
stringany
anyTransformsRollupImplementation
inputTablesTransformInputTable[]Show propertiesHide properties
Array of
TransformInputTablenamestringrequiredtopicMatcherRegexstringrequiredcreateTableSQLstring | anyShow propertiesHide properties
Any of:
string
stringany
anyrollupSQLstringrequiredkeyFieldsstring[]sourceIdleTimeoutMsintegerdefault: 30000
stateTTLMsintegerdefault: 86400000
TransformsTopicRouterImplementation
topic_prefixstringDeprecated - kept for backwards compat with existing DB records
default: ""
kc_cluster_idstring | anyKC cluster to deploy the connector to
Show propertiesHide properties
Any of:
string
stringany
anyany
anymetricsTransformMetric | anyShow propertiesHide properties
Any of:
TransformMetric
tasksinteger | anyShow propertiesHide properties
Any of:
integer
integerany
anylatencyinteger | anyShow propertiesHide properties
Any of:
integer
integerany
anystatusstring | anyShow propertiesHide properties
Any of:
string
stringany
anydurationinteger | anyShow propertiesHide properties
Any of:
integer
integerany
anystart_timeinteger | string | string<date-time> | anyShow propertiesHide properties
Any of:
integer
integerstring
stringstring<date-time>
string<date-time>any
anyend_timestring | string<date-time> | anyShow propertiesHide properties
Any of:
string
stringstring<date-time>
string<date-time>any
anycheckpointsTransformCheckpointsInfo | anyShow propertiesHide properties
Any of:
TransformCheckpointsInfo
job_idstringrequiredcountsobjectrequiredsummaryobjectrequiredlatestTransformCheckpointHistory | anyShow propertiesHide properties
Any of:
TransformCheckpointHistory
idintegerrequiredstatusstringrequiredis_savepointbooleanrequiredtrigger_timestampintegerrequiredlatest_ack_timestampintegerrequiredstate_sizeintegerrequiredend_to_end_durationintegerrequiredalignment_bufferedintegerrequirednum_subtasksintegerrequirednum_acknowledged_subtasksintegerrequiredany
anyhistoryTransformCheckpointHistory[]default: []
Show propertiesHide properties
Array of
TransformCheckpointHistoryidintegerrequiredstatusstringrequiredis_savepointbooleanrequiredtrigger_timestampintegerrequiredlatest_ack_timestampintegerrequiredstate_sizeintegerrequiredend_to_end_durationintegerrequiredalignment_bufferedintegerrequirednum_subtasksintegerrequirednum_acknowledged_subtasksintegerrequiredoperator_breakdownTransformOperatorState[]default: []
Show propertiesHide properties
Array of
TransformOperatorStateoperator_idstringrequiredoperator_namestringrequiredstate_sizeintegerrequiredcheckpointed_sizeintegerrequiredend_to_end_durationintegerrequiredparallelismintegerrequiredany
anyany
anylive_versionstring | anyShow propertiesHide properties
Any of:
string
stringany
anypreview_versionstring | anyShow propertiesHide properties
Any of:
string
stringany
anyversionintegerdefault: 1
updated_timestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyimplementation_updated_timestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anydescriptionstring | anyShow propertiesHide properties
Any of:
string
stringany
anytagsstring[] | anyList of tag IDs assigned to this transform
Show propertiesHide properties
Any of:
string[]
Array of
stringstringany
anyhistory_created_timestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyhistory_updated_timestampstring<date-time> | anyShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
any422
Validation Error
detailValidationError[]Show propertiesHide properties
Array of
ValidationErrorlocstring | integer[]requiredShow propertiesHide properties
Array of
string | integerAny of:
string
stringinteger
integermsgstringrequiredtypestringrequiredinputanyctxobject