api

Type Members

1. class AdditionalVariable extends Annotation with Annotation with ClassfileAnnotation

   

2. class AdditionalVariables extends Annotation with Annotation with ClassfileAnnotation

   

3. class BranchParamName extends Annotation with Annotation with ClassfileAnnotation

   

4. case class Context(id: String, variables: Map[String, Any], lazyContext: LazyContext, parentContext: Option[Context]) extends Product with Serializable

   

5. abstract class CustomStreamTransformer extends AnyRef

   

   Hook for using Apache Flink API directly.

   Hook for using Apache Flink API directly. See examples in pl.touk.nussknacker.engine.example.custom

   IMPORTANT lifecycle notice: Implementations of this class *must not* allocate resources (connections, file handles etc.)

6. case class DeadEndReference(nodeId: String) extends EndingReference with Product with Serializable

   

7. trait DisplayJson extends AnyRef

   

   Used to show variables in UI pl.touk.nussknacker.engine.api.DisplayJson#originalDisplay method can be used to show original input if needed (i.e useful for csv record), so in UI variable will be pretty-printed in json format and raw-printed.

8. abstract class DisplayJsonWithEncoder[T] extends DisplayJson

   

9. trait Displayable extends DisplayJson

   

   Used to show variables in UI pl.touk.nussknacker.engine.api.Displayable#originalDisplay method can be used to show original input if needed (i.e useful for csv record), so in UI variable will be pretty-printed in json format and raw-printed.

10. abstract class DisplayableAsJson[T] extends Displayable

    

11. class Documentation extends Annotation with Annotation with ClassfileAnnotation

    

12. trait EmptyProcessListener extends ProcessListener

    

13. case class EndReference(nodeId: String) extends EndingReference with Product with Serializable

    

14. sealed trait EndingReference extends PartReference

    

15. case class Group(id: String, nodes: Set[String]) extends Product with Serializable

    

16. class Hidden extends Annotation with Annotation with ClassfileAnnotation

    

17. trait HideToString extends AnyRef

    

18. case class InterpretationResult(reference: PartReference, output: Any, finalContext: Context) extends Product with Serializable

    

19. case class JobData(metaData: MetaData, processVersion: ProcessVersion) extends Product with Serializable

    

20. case class JoinReference(id: String, joinId: String) extends PartReference with Product with Serializable

    

21. trait LazyParameter[+T] extends AnyRef

    

    Lazy parameter is representation of parameter of custom node which should be evaluated for each record: def execute(@ParamName("keyBy") keyBy: LazyParameter[String], @ParamName ("length") length: String) In this case, length is computed as constant during process compilation, while keyBy is evaluated for each event Cannot be evaluated directly (no method like 'evaluate', as evaluation may need e.g.

    Lazy parameter is representation of parameter of custom node which should be evaluated for each record: def execute(@ParamName("keyBy") keyBy: LazyParameter[String], @ParamName ("length") length: String) In this case, length is computed as constant during process compilation, while keyBy is evaluated for each event Cannot be evaluated directly (no method like 'evaluate', as evaluation may need e.g. lazy variables and we have to take care of lifecycle, to use it see LazyParameterInterpreter

22. trait LazyParameterInterpreter extends AnyRef

    

23. trait Lifecycle extends AnyRef

    

24. case class MetaData(id: String, typeSpecificData: TypeSpecificData, isSubprocess: Boolean = false, additionalFields: Option[ProcessAdditionalFields] = scala.None, subprocessVersions: Map[String, Long] = ...) extends Product with Serializable

    

25. class MethodToInvoke extends Annotation with Annotation with ClassfileAnnotation

    

26. case class NextPartReference(id: String) extends PartReference with Product with Serializable

    

27. class OutputVariableName extends Annotation with Annotation with ClassfileAnnotation

    

28. class ParamName extends Annotation with Annotation with ClassfileAnnotation

    

29. sealed trait PartReference extends AnyRef

    

30. case class ProcessAdditionalFields(description: Option[String], groups: Set[Group], properties: Map[String, String]) extends Product with Serializable

    

31. trait ProcessListener extends Lifecycle

    

32. case class ProcessVersion(versionId: Long, processName: ProcessName, user: String, modelVersion: Option[Int]) extends Product with Serializable

    

33. class QueryableStateNames extends Annotation with Annotation with ClassfileAnnotation

    

34. abstract class Service extends Lifecycle

    

    Interface of Enricher/Processor.

    Interface of Enricher/Processor. It has to have one method annotated with pl.touk.nussknacker.engine.api.MethodToInvoke. This method is called for every service invocation.

    This could be scala-trait, but we leave it as abstract class for now for java compatibility.

    TODO We should consider separate interfaces for java implementation, but right now we convert ProcessConfigCreator from java to scala one and is seems difficult to convert java CustomStreamTransformer, Service etc. into scala ones

    IMPORTANT lifecycle notice: Implementations of this class *must not* allocate resources (connections, file handles etc.) unless open() *or* appropriate @MethodToInvoke is called

35. case class StandaloneMetaData(path: Option[String]) extends TypeSpecificData with Product with Serializable

    

36. case class StreamMetaData(parallelism: Option[Int] = None, splitStateToDisk: Option[Boolean] = Some(true), useAsyncInterpretation: Option[Boolean] = None, checkpointIntervalInSeconds: Option[Long] = None) extends TypeSpecificData with Product with Serializable

    

37. sealed trait TypeSpecificData extends AnyRef

    

38. case class ValueWithContext[T](value: T, context: Context) extends Product with Serializable

    

39. trait WithFields extends DisplayJson

    

40. trait WithJobData extends AnyRef