Skip to content

Channel

faststream.specification.asyncapi.v2_6_0.schema.Channel #

Bases: BaseModel

A class to represent a channel.

ATTRIBUTE DESCRIPTION
description

optional description of the channel

servers

optional list of servers associated with the channel

bindings

optional channel binding

subscribe

optional operation for subscribing to the channel

publish

optional operation for publishing to the channel

Configurations

model_config : configuration for the model (only applicable for Pydantic version 2) Config : configuration for the class (only applicable for Pydantic version 1)

description class-attribute instance-attribute #

description = None

servers class-attribute instance-attribute #

servers = None

bindings class-attribute instance-attribute #

bindings = None

subscribe class-attribute instance-attribute #

subscribe = None

publish class-attribute instance-attribute #

publish = None

model_config class-attribute instance-attribute #

model_config = {'extra': 'allow'}

Config #

extra class-attribute instance-attribute #

extra = 'allow'

from_sub classmethod #

from_sub(subscriber)
Source code in faststream/specification/asyncapi/v2_6_0/schema/channels.py
@classmethod
def from_sub(cls, subscriber: SubscriberSpec) -> Self:
    return cls(
        description=subscriber.description,
        servers=None,
        bindings=ChannelBinding.from_sub(subscriber.bindings),
        subscribe=None,
        publish=Operation.from_sub(subscriber.operation),
    )

from_pub classmethod #

from_pub(publisher)
Source code in faststream/specification/asyncapi/v2_6_0/schema/channels.py
@classmethod
def from_pub(cls, publisher: PublisherSpec) -> Self:
    return cls(
        description=publisher.description,
        servers=None,
        bindings=ChannelBinding.from_pub(publisher.bindings),
        subscribe=Operation.from_pub(publisher.operation),
        publish=None,
    )