Skip to content

JStream

faststream.nats.js_stream.JStream #

JStream(
    name: str,
    *args: Any,
    declare: bool = True,
    **kwargs: Any
)

Bases: NameRequired

Source code in faststream/nats/js_stream.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def __init__(
    self,
    name: str,
    *args: Any,
    declare: bool = True,
    **kwargs: Any,
) -> None:
    super().__init__(
        name=name,
        declare=declare,
        subjects=[],
        config=StreamConfig(
            *args,
            name=name,
            **kwargs,  # type: ignore[misc]
        ),
    )

config instance-attribute #

config: StreamConfig

declare class-attribute instance-attribute #

declare: bool = Field(default=True)

name class-attribute instance-attribute #

name: str = Field(...)

subjects class-attribute instance-attribute #

subjects: List[str] = Field(default_factory=list)

validate classmethod #

validate(
    value: Union[str, NameRequiredCls, None]
) -> Optional[NameRequiredCls]

Validates a value.

PARAMETER DESCRIPTION
value

The value to be validated.

TYPE: Union[str, NameRequiredCls, None]

RETURNS DESCRIPTION
Optional[NameRequiredCls]

The validated value.

Note

The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)

Source code in faststream/broker/schemas.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@classmethod
def validate(
    cls: Type[NameRequiredCls], value: Union[str, NameRequiredCls, None]
) -> Optional[NameRequiredCls]:
    """Validates a value.

    Args:
        value: The value to be validated.

    Returns:
        The validated value.
    !!! note

        The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)
    """
    if value is not None:
        if isinstance(value, str):
            value = cls(value)
    return value
Last update: 2023-11-13