trait AkkaStreamletContext extends StreamletContext
Runtime context for AkkaStreamlets, which provides means to create Sources and Sinks respectively
for CodeInlets and CodeOutlets.
The StreamletContext also contains some lifecycle hooks, like signalReady, onStop and stop
and provides access to the streamlet configuration.
It also provides the ActorSystem and Materializer that will be used to run the AkkaStreamlet.
- Alphabetic
- By Inheritance
- AkkaStreamletContext
- StreamletContext
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
case class
MountedPathUnavailableException(volumeMount: VolumeMount) extends Exception with Product with Serializable
- Definition Classes
- StreamletContext
Abstract Value Members
-
abstract
def
alive(localMode: Boolean): Unit
Marks the streamlet pod "alive" for Kubernetes.
-
abstract
def
ready(localMode: Boolean): Unit
Marks the streamlet pod "ready" for Kubernetes.
-
abstract
def
signalReady(): Boolean
Signals that the streamlet is ready to process data.
Signals that the streamlet is ready to process data.
When a streamlet is run using
AkkaStreamletTestkit.run, a StreamletExecution is returned.signalReadycompletes the ready future. ready can be used for instance to wait for a Server to signal that it is ready to accept requests.- returns
trueif and only if successfully signalled. Otherwisefalse.
-
abstract
def
stop(): Future[Dun]
Stops the streamlet.
-
abstract
def
stopOnException(nonFatal: Throwable): Unit
Stops the streamlet knowing an exception occured.
-
implicit abstract
def
system: ActorSystem
The system in which the AkkaStreamlet will be run.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
config: Config
The full configuration for the Streamlet, containing all deployment-time configuration parameters on top of the normal configuration
The full configuration for the Streamlet, containing all deployment-time configuration parameters on top of the normal configuration
- Definition Classes
- StreamletContext
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
findTopicForPort(port: StreamletPort): Topic
Get the savepoint path (topic name) from the port
Get the savepoint path (topic name) from the port
- port
the StreamletPort
- returns
the savepoint path
- Definition Classes
- StreamletContext
- Exceptions thrown
TopicForPortNotFoundExceptionif there is no mapping found
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getMountedPath(volumeMount: VolumeMount): Path
The path mounted for a VolumeMount request from a streamlet.
The path mounted for a VolumeMount request from a streamlet. In a clustered deployment, the mounted path will correspond to the requested mount path in the VolumeMount definition. In a local environment, this path will be replaced by a local folder.
- volumeMount
the volumeMount declaration for which we want to obtain the mounted path.
- returns
the path where the volume is mounted.
- Definition Classes
- StreamletContext
- Exceptions thrown
MountedPathUnavailableExceptionin the case the path is not available.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
killSwitch: SharedKillSwitch
- Attributes
- protected
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
onStop(f: () ⇒ Future[Dun]): Unit
Registers a callback, which is called when the streamlet is stopped.
Registers a callback, which is called when the streamlet is stopped. It is usually used to close resources that have been created in the streamlet.
-
def
runtimeBootstrapServers(topic: Topic): String
The runtime 'bootstrap.servers' for the given topic.
The runtime 'bootstrap.servers' for the given topic. This is provided by the cloudflow-operator when creating the streamlet's 'cloudflow.runner' configuration. A 'bootstrap.servers' will always be provided as long as a 'default' Kafka cluster is defined during the install of the cloudflow-operator.
- Definition Classes
- StreamletContext
-
final
def
streamletConfig: Config
The subset of configuration specific to a single named instance of a streamlet.
The subset of configuration specific to a single named instance of a streamlet.
A Streamlet can specify the set of environment- and instance-specific configuration keys it will use during runtime through configParameters. Those keys will then be made available through this configuration.
An empty configuration will be returned if the streamlet doesn't contain any configuration parameters.
- Definition Classes
- StreamletContext
-
def
streamletRef: String
The streamlet reference which identifies the streamlet in the blueprint.
The streamlet reference which identifies the streamlet in the blueprint. It is used in a Streamlet for logging and metrics, referring back to the streamlet instance using a name recognizable by the user.
- Definition Classes
- StreamletContext
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()