On this page
article
API reference
Ecida
EcidaModule Objects
class EcidaModule()
set_kafka_config
def set_kafka_config(config: dict[str, Any])
Set Kafka consumer and producer configuration parameters.
Arguments:
config
dict - Dict containing Kafka configuration parameters like ‘session.timeout.ms’, ‘heartbeat.interval.ms’, etc.
pull
def pull(input_name: str, timeout_ms: int | None = None) -> str | None
Pull data from the specified input, with an optional timeout. If no timeout is set, will wait indefinitely.
NOTE: either always use a timeout or not - do not omit the timeout only from some calls.
Arguments:
input_name
str - The name of the input to pull from
Returns:
str
- The data pulled from the input
get_config
def get_config(conf: str) -> str | None
Get the value of a config.
Arguments:
conf
str - Name of the config to get the value of
Returns:
str | None: The config value, or None if the config does not exist or was not set.
enable_large_messages
def enable_large_messages()
Allow sending and receiving larger messages than default.