Skip to content

RedisSentinelParams

faststream.redis.schemas.types.RedisSentinelParams #

Bases: RedisBrokerParams

sentinels instance-attribute #

sentinels: Required[Sequence[tuple[str, int]]]

Redis Sentinel (host, port) nodes to discover the master from. Required.

sentinel_master_name instance-attribute #

sentinel_master_name: Required[str]

Sentinel master group name. Required.

sentinel_kwargs instance-attribute #

sentinel_kwargs: Mapping[str, Any] | None

Connection kwargs for the Sentinel nodes themselves. Defaults to None.

host instance-attribute #

host: str

Redis host. Extracted from URL if not set. Defaults to EMPTY.

port instance-attribute #

port: str | int

Redis port. Extracted from URL if not set. Defaults to EMPTY.

db instance-attribute #

db: str | int

Redis database number. Defaults to EMPTY.

connection_class instance-attribute #

connection_class: type[Connection]

Connection class. Defaults to EMPTY.

client_name instance-attribute #

client_name: str | None

Redis client name. Defaults to None.

health_check_interval instance-attribute #

health_check_interval: float

Health check interval. Defaults to 0.

max_connections instance-attribute #

max_connections: int | None

Max connections in pool. Defaults to None.

socket_timeout instance-attribute #

socket_timeout: float | None

Socket operation timeout. Defaults to None.

socket_connect_timeout instance-attribute #

socket_connect_timeout: float | None

Socket connection timeout. Defaults to None.

socket_read_size instance-attribute #

socket_read_size: int

Socket read buffer size. Defaults to 65536.

socket_keepalive instance-attribute #

socket_keepalive: bool

Enable TCP keepalive. Defaults to False.

socket_keepalive_options instance-attribute #

socket_keepalive_options: Mapping[int, int | bytes] | None

TCP keepalive options. Defaults to None.

socket_type instance-attribute #

socket_type: int

Socket type. Defaults to 0.

retry instance-attribute #

retry: Retry | None

Retry object. Defaults to None.

retry_on_error instance-attribute #

retry_on_error: list[Any]

List of exceptions for which you need to retry. Defaults to [].

retry_on_timeout instance-attribute #

retry_on_timeout: bool

Retry on timeout. Defaults to False.

encoding instance-attribute #

encoding: str

Encoding for data. Defaults to "utf-8".

encoding_errors instance-attribute #

encoding_errors: str

Encoding error handling. Defaults to "strict".

parser_class instance-attribute #

parser_class: type[BaseParser]

Parser class. Defaults to DefaultParser.

encoder_class instance-attribute #

encoder_class: type[Encoder]

Encoder class. Defaults to Encoder.

graceful_timeout instance-attribute #

graceful_timeout: float | None

Graceful shutdown timeout. Defaults to 15.0.

ack_policy instance-attribute #

ack_policy: AckPolicy

Default acknowledgement policy. Defaults to EMPTY.

id_generator instance-attribute #

id_generator: IdGenerator

Factory used to generate correlation_id when a publish/request call doesn't set one.

Defaults to gen_cor_id (uuid4-based).

decoder instance-attribute #

decoder: CustomCallable | None

Custom message decoder. Defaults to None.

codec instance-attribute #

codec: CodecProto | None

Custom codec. Defaults to None.

parser instance-attribute #

parser: CustomCallable | None

Custom message parser. Defaults to None.

dependencies instance-attribute #

dependencies: Sequence[Dependant]

Subscriber dependencies. Defaults to ().

middlewares instance-attribute #

middlewares: Sequence[BrokerMiddleware[Any, Any]]

Global middlewares. Defaults to ().

routers instance-attribute #

routers: Iterable[RedisRegistrator]

Routers to include. Defaults to ().

message_format instance-attribute #

message_format: type[MessageFormat]

Message serialization format. Defaults to BinaryMessageFormatV1.

security instance-attribute #

security: BaseSecurity | None

Security options. Defaults to None.

specification_url instance-attribute #

specification_url: str | None

AsyncAPI server address. Defaults to None.

protocol instance-attribute #

protocol: str | None

AsyncAPI protocol. Defaults to None.

protocol_version instance-attribute #

protocol_version: str | None

AsyncAPI protocol version. Defaults to "custom".

description instance-attribute #

description: str | None

AsyncAPI description. Defaults to None.

tags instance-attribute #

tags: Iterable[Tag | TagDict]

AsyncAPI tags. Defaults to ().

logger instance-attribute #

logger: LoggerProto

Custom logger. Defaults to EMPTY.

log_level instance-attribute #

log_level: int

Service log level. Defaults to logging.INFO.

apply_types instance-attribute #

apply_types: bool

Use FastDepends type casting. Defaults to True.

serializer instance-attribute #

serializer: SerializerProto

Custom serializer. Defaults to EMPTY.

provider instance-attribute #

provider: Provider | None

FastDepends provider. Defaults to None.

context instance-attribute #

context: ContextRepo | None

Context repository. Defaults to None.