Skip to main content
Version: Beta 🚧

PushConfig

Summary​

The PushConfig class is used to configure the Stream Ingest API to allow ingestion of records via the Stream Ingest API.
 
Declaring this configuration class alone will not register a Data Source. Instead, declare as a part of StreamSource that takes this configuration class instance as a parameter.

Example

from tecton import PushConfig
stream_config = PushConfig(log_offline=False)

Methods​

NameDescription
__init__(...)Instantiates a new PushConfig.

__init__(...)​

Instantiates a new PushConfig.

Parameters

  • log_offline (bool) - If set to True, the Stream Ingest API will log the incoming records for the push source to an offline table. Default: false

  • post_processor (Union[Callable[[Dict],Union[Dict, NoneType]],Callable[[pandas.core.frame.DataFrame],Union[pandas.core.frame.DataFrame, NoneType]], NoneType]) - A user-defined function that processes records coming from the source; the output of the post_processor is used in subsequent stages. Default: None

  • post_processor_mode (Optional[str]) - Execution mode for the post_processor, must be one of python or pandas Default: None

  • input_schema (Optional[List[Field]]) - Input schema for the post_processor Default: None

  • timestamp_field (Optional[str]) - Name of the timestamp column which Tecton uses for watermarking. Default: None

Returns

A PushConfig class instance.

Was this page helpful?