esgf_playground_utils.config.kafka
==================================

.. py:module:: esgf_playground_utils.config.kafka

.. autoapi-nested-parse::

   Configuration module for the ESGF-Playground.



Classes
-------

.. autoapisummary::

   esgf_playground_utils.config.kafka.Settings


Module Contents
---------------

.. py:class:: Settings(_case_sensitive: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, Ellipsis] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _secrets_dir: str | pathlib.Path | None = None, **values: Any)

   Bases: :py:obj:`pydantic_settings.BaseSettings`


   Container for configuration of the ESGF-Playground.

   By default, this configuration is valid for running the consumer on localhost, with a Kafka broker on localhost,
   provided it is given a `consumer_group` value. It will subscribe the consumer to all topics.


   .. py:attribute:: model_config

      Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].



   .. py:attribute:: bootstrap_servers
      :type:  List[str]
      :value: ['localhost']



   .. py:attribute:: consumer_group
      :type:  Optional[str]
      :value: None



   .. py:attribute:: kafka_topics
      :type:  Pattern[str]


   .. py:attribute:: sasl_mechanism
      :type:  str
      :value: 'PLAIN'



   .. py:attribute:: security_protocol
      :type:  str
      :value: 'PLAINTEXT'



   .. py:attribute:: sasl_plain_username
      :type:  Optional[str]
      :value: None



   .. py:attribute:: sasl_plain_password
      :type:  Optional[str]
      :value: None



   .. py:attribute:: stac_server
      :type:  pydantic.HttpUrl