aligned.data_source.stream_data_source.StreamDataSource

class documentation

class StreamDataSource(ABC, Codable, SerializableType): (source)

Known subclasses: aligned.HttpStreamSource, aligned.sources.kafka.KafkaTopicConfig, aligned.sources.redis.RedisStreamSource

Constructor: StreamDataSource._deserialize(value)

View In Hierarchy

Used to determend if an API call should be created, or if we should listen to a stream.

Method consumer Returns a consumer that actually can load data
Class Variable name Undocumented
Class Variable topic_name Undocumented
Class Method _deserialize Undocumented
Method _serialize Undocumented
def consumer(self, from_timestamp: str | None = None) -> ReadableStream: (source)
overridden in aligned.sources.kafka.KafkaTopicConfig, aligned.sources.redis.RedisStreamSource

Returns a consumer that actually can load data

E.g: ```python redis_config = RedisConfig(env_var="REDIS_URL")

consumer = redis_config.consumer() ```

Returns:
ReadableStream: A stream you can read records from
name: str = (source)
overridden in aligned.HttpStreamSource, aligned.sources.kafka.KafkaTopicConfig, aligned.sources.redis.RedisStreamSource

Undocumented

topic_name: str = (source)
overridden in aligned.HttpStreamSource, aligned.sources.kafka.KafkaTopicConfig, aligned.sources.redis.RedisStreamSource

Undocumented

@classmethod
def _deserialize(cls, value: dict) -> StreamDataSource: (source)

Undocumented

def _serialize(self) -> dict: (source)

Undocumented