nv_ingest_api.internal.schemas.message_brokers package#

Submodules#

nv_ingest_api.internal.schemas.message_brokers.message_broker_client_schema module#

class nv_ingest_api.internal.schemas.message_brokers.message_broker_client_schema.MessageBrokerClientSchema(
*,
host: str = 'redis',
port: ~typing.Annotated[int,
~annotated_types.Gt(gt=0),
~annotated_types.Lt(lt=65536)] = 6379,
client_type: ~typing.Literal['redis',
'simple'] = 'redis',
broker_params: dict | None = <factory>,
connection_timeout: ~typing.Annotated[int,
~annotated_types.Ge(ge=0)] = 300,
max_backoff: ~typing.Annotated[int,
~annotated_types.Ge(ge=0)] = 300,
max_retries: ~typing.Annotated[int,
~annotated_types.Ge(ge=0)] = 0,
)[source]#

Bases: BaseModel

Configuration schema for message broker client connections. Supports Redis or simple in-memory clients.

broker_params: dict | None#
client_type: Literal['redis', 'simple']#
connection_timeout: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0)])]#
host: str#
max_backoff: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0)])]#
max_retries: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0)])]#
model_config: ClassVar[ConfigDict] = {}#

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

port: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0), Lt(lt=65536)])]#

nv_ingest_api.internal.schemas.message_brokers.request_schema module#

class nv_ingest_api.internal.schemas.message_brokers.request_schema.PopRequestSchema(
*,
command: str,
queue_name: Annotated[str, MinLen(min_length=1)],
timeout: float | None = 100,
)[source]#

Bases: BaseModel

command: str#
model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#

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

queue_name: str#
timeout: float | None#
class nv_ingest_api.internal.schemas.message_brokers.request_schema.PushRequestSchema(
*,
command: str,
queue_name: Annotated[str, MinLen(min_length=1)],
message: Annotated[str, MinLen(min_length=1)],
timeout: float | None = 100,
)[source]#

Bases: BaseModel

command: str#
message: str#
model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#

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

queue_name: str#
timeout: float | None#
class nv_ingest_api.internal.schemas.message_brokers.request_schema.SizeRequestSchema(
*,
command: str,
queue_name: Annotated[str, MinLen(min_length=1)],
)[source]#

Bases: BaseModel

command: str#
model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#

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

queue_name: str#

nv_ingest_api.internal.schemas.message_brokers.response_schema module#

class nv_ingest_api.internal.schemas.message_brokers.response_schema.ResponseSchema(
*,
response_code: int,
response_reason: str | None = 'OK',
response: str | dict | None = None,
trace_id: str | None = None,
transaction_id: str | None = None,
)[source]#

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}#

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

response: str | dict | None#
response_code: int#
response_reason: str | None#
trace_id: str | None#
transaction_id: str | None#

Module contents#