package api
- Alphabetic
- Public
- Protected
Package Members
Type Members
- trait AdditionalVariable extends Annotation
- Annotations
- @Target() @Retention()
- trait AdditionalVariables extends Annotation
- Annotations
- @Target() @Retention()
- trait BranchParamName extends Annotation
- Annotations
- @Target() @Retention()
- case class Context(id: String, variables: Map[String, Any], parentContext: Option[Context]) extends Product with Serializable
Context is container for variables used in expression evaluation
Context is container for variables used in expression evaluation
- id
correlation id/trace id used for tracing (logs, error presentation) and for tests mechanism, it should be always defined
- variables
variables available in evaluation
- parentContext
context used for scopes handling, mainly for fragment invocation purpose
- case class ContextId(value: String) extends Product with Serializable
- abstract class CustomStreamTransformer extends Component with AllProcessingModesComponent
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.)
To make implementation easier, by default, stream transformers handle all processing modes. If you have some processing mode specific component, you should override allowedProcessingModes method
- trait DefaultValue extends Annotation
- Annotations
- @Target() @Retention()
- trait Documentation extends Annotation
- Annotations
- @Target() @Retention()
- abstract class EagerService extends Service
- trait Hidden extends Annotation
- Annotations
- @Target() @Retention()
- trait HideToString extends AnyRef
Implementing this interface results in hiding toString method in code completion
- trait LazyParameter[+T <: AnyRef] extends Serializable
Lazy parameter is representation of parameter of custom node which should be evaluated for each record:
In this case, length is computed as constant during process compilation, while groupBy is evaluated for each event Cannot be evaluated directly (no method like 'evaluate'), as evaluation may need lifecycle handling, to use it see LazyParameterInterpreterdef execute(@ParamName("groupBy") groupBy: LazyParameter[String], @ParamName ("length") length: String)
Lazy parameter is representation of parameter of custom node which should be evaluated for each record:
In this case, length is computed as constant during process compilation, while groupBy is evaluated for each event Cannot be evaluated directly (no method like 'evaluate'), as evaluation may need lifecycle handling, to use it see LazyParameterInterpreterdef execute(@ParamName("groupBy") groupBy: LazyParameter[String], @ParamName ("length") length: String)
- T
type of evaluated parameter. It has upper bound AnyRef because currently we don't support correctly extraction of primitive types from generic parameters
- trait Lifecycle extends AutoCloseable
- trait MethodToInvoke extends Annotation
- Annotations
- @Target() @Retention()
- trait OutputVariableName extends Annotation
- Annotations
- @Target() @Retention()
- trait ParamName extends Annotation
- Annotations
- @Target() @Retention()
- final case class Params(nameToValueMap: Map[ParameterName, Any]) extends Product with Serializable
- abstract class Service extends Lifecycle with Component with AllProcessingModesComponent
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
- trait ServiceInvoker extends AnyRef
- trait ToEvaluateFunctionConverter extends AnyRef
- case class ValueWithContext[T](value: T, context: Context) extends Product with Serializable
Value Members
- object Context extends Serializable
- object LazyParameter extends Serializable
- object Params extends Serializable
- object VariableConstants