ConsumerConnectionParams
faststream.kafka.schemas.params.ConsumerConnectionParams #
Bases: TypedDict
A class to represent the connection parameters for a consumer.
ATTRIBUTE | DESCRIPTION |
---|---|
bootstrap_servers | Required. The bootstrap servers to connect to.
|
loop | Optional. The event loop to use for asynchronous operations.
|
client_id | The client ID to use for the connection.
|
request_timeout_ms | The timeout for network requests in milliseconds.
|
retry_backoff_ms | The backoff time in milliseconds for retrying failed requests.
|
metadata_max_age_ms | The maximum age of metadata in milliseconds.
|
security_protocol | The security protocol to use for the connection. Must be one of "SSL" or "PLAINTEXT".
|
api_version | The API version to use for the connection.
|
connections_max_idle_ms | The maximum idle time in milliseconds before closing a connection.
|
sasl_mechanism | The SASL mechanism to use for authentication. Must be one of "PLAIN", "GSSAPI", "SCRAM-SHA-256", "SCRAM-SHA-512", or "OAUTHBEARER".
|
sasl_plain_password | The password to use for PLAIN SASL mechanism.
|
sasl_plain_username | The username to use for PLAIN SASL mechanism.
|
sasl_kerberos_service_name | The service
|