Skip to content

ConsumerConnectionParams

faststream.kafka.shared.schemas.ConsumerConnectionParams #

Bases: TypedDict

A class to represent the connection parameters for a consumer.

api_version instance-attribute #

api_version: str

bootstrap_servers instance-attribute #

bootstrap_servers: Required[Union[str, List[str]]]

client_id instance-attribute #

client_id: str

connections_max_idle_ms instance-attribute #

connections_max_idle_ms: int

loop instance-attribute #

loop: Optional[AbstractEventLoop]

metadata_max_age_ms instance-attribute #

metadata_max_age_ms: int

request_timeout_ms instance-attribute #

request_timeout_ms: int

retry_backoff_ms instance-attribute #

retry_backoff_ms: int

sasl_kerberos_domain_name instance-attribute #

sasl_kerberos_domain_name: str

sasl_kerberos_service_name instance-attribute #

sasl_kerberos_service_name: str

sasl_mechanism instance-attribute #

sasl_mechanism: Literal[
    "PLAIN",
    "GSSAPI",
    "SCRAM-SHA-256",
    "SCRAM-SHA-512",
    "OAUTHBEARER",
]

sasl_oauth_token_provider instance-attribute #

sasl_oauth_token_provider: AbstractTokenProvider

sasl_plain_password instance-attribute #

sasl_plain_password: str

sasl_plain_username instance-attribute #

sasl_plain_username: str

security_protocol instance-attribute #

security_protocol: Literal['SSL', 'PLAINTEXT']

ssl_context instance-attribute #

ssl_context: SSLContext