aries_cloudagent.protocols.routing.v1_0.messages package

Submodules

aries_cloudagent.protocols.routing.v1_0.messages.forward module

Represents a forward message.

class aries_cloudagent.protocols.routing.v1_0.messages.forward.Forward(*, to: Optional[str] = None, msg: Optional[Union[dict, str]] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Represents a request to forward a message to a connected agent.

class Meta[source]

Bases: object

Forward metadata.

handler_class = 'aries_cloudagent.protocols.routing.v1_0.handlers.forward_handler.ForwardHandler'
message_type = 'routing/1.0/forward'
schema_class = 'ForwardSchema'
class aries_cloudagent.protocols.routing.v1_0.messages.forward.ForwardSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Forward message schema used in serialization/deserialization.

class Meta[source]

Bases: object

ForwardSchema metadata.

model_class

alias of aries_cloudagent.protocols.routing.v1_0.messages.forward.Forward

handle_str_message(data, **kwargs)

Accept string value for msg, as produced by previous implementation.

msg
to

aries_cloudagent.protocols.routing.v1_0.messages.route_query_request module

Query existing forwarding routes.

class aries_cloudagent.protocols.routing.v1_0.messages.route_query_request.RouteQueryRequest(*, filter: Optional[dict] = None, paginate: Optional[aries_cloudagent.protocols.routing.v1_0.models.paginate.Paginate] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Query existing routes from a routing agent.

class Meta[source]

Bases: object

RouteQueryRequest metadata.

handler_class = 'aries_cloudagent.protocols.routing.v1_0.handlers.route_query_request_handler.RouteQueryRequestHandler'
message_type = 'routing/1.0/route-query-request'
schema_class = 'RouteQueryRequestSchema'
class aries_cloudagent.protocols.routing.v1_0.messages.route_query_request.RouteQueryRequestSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

RouteQueryRequest message schema used in serialization/deserialization.

class Meta[source]

Bases: object

RouteQueryRequestSchema metadata.

model_class

alias of aries_cloudagent.protocols.routing.v1_0.messages.route_query_request.RouteQueryRequest

filter
paginate

aries_cloudagent.protocols.routing.v1_0.messages.route_query_response module

Return existing forwarding routes in response to a query.

class aries_cloudagent.protocols.routing.v1_0.messages.route_query_response.RouteQueryResponse(*, routes: Optional[Sequence[aries_cloudagent.protocols.routing.v1_0.models.route_query_result.RouteQueryResult]] = None, paginated: Optional[aries_cloudagent.protocols.routing.v1_0.models.paginated.Paginated] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Return existing routes from a routing agent.

class Meta[source]

Bases: object

RouteQueryResponse metadata.

handler_class = 'aries_cloudagent.protocols.routing.v1_0.handlers.route_query_response_handler.RouteQueryResponseHandler'
message_type = 'routing/1.0/route-query-response'
schema_class = 'RouteQueryResponseSchema'
class aries_cloudagent.protocols.routing.v1_0.messages.route_query_response.RouteQueryResponseSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

RouteQueryResponse message schema used in serialization/deserialization.

class Meta[source]

Bases: object

RouteQueryResponseSchema metadata.

model_class

alias of aries_cloudagent.protocols.routing.v1_0.messages.route_query_response.RouteQueryResponse

paginated
routes

aries_cloudagent.protocols.routing.v1_0.messages.route_update_request module

Request to update forwarding routes.

class aries_cloudagent.protocols.routing.v1_0.messages.route_update_request.RouteUpdateRequest(*, updates: Optional[Sequence[aries_cloudagent.protocols.routing.v1_0.models.route_update.RouteUpdate]] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Request to existing routes with a routing agent.

class Meta[source]

Bases: object

RouteUpdateRequest metadata.

handler_class = 'aries_cloudagent.protocols.routing.v1_0.handlers.route_update_request_handler.RouteUpdateRequestHandler'
message_type = 'routing/1.0/route-update-request'
schema_class = 'RouteUpdateRequestSchema'
class aries_cloudagent.protocols.routing.v1_0.messages.route_update_request.RouteUpdateRequestSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

RouteUpdateRequest message schema used in serialization/deserialization.

class Meta[source]

Bases: object

RouteUpdateRequestSchema metadata.

model_class

alias of aries_cloudagent.protocols.routing.v1_0.messages.route_update_request.RouteUpdateRequest

updates

aries_cloudagent.protocols.routing.v1_0.messages.route_update_response module

Response for a route update request.

class aries_cloudagent.protocols.routing.v1_0.messages.route_update_response.RouteUpdateResponse(*, updated: Optional[Sequence[aries_cloudagent.protocols.routing.v1_0.models.route_updated.RouteUpdated]] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Response for a route update request.

class Meta[source]

Bases: object

RouteUpdateResponse metadata.

handler_class = 'aries_cloudagent.protocols.routing.v1_0.handlers.route_update_response_handler.RouteUpdateResponseHandler'
message_type = 'routing/1.0/route-update-response'
schema_class = 'RouteUpdateResponseSchema'
class aries_cloudagent.protocols.routing.v1_0.messages.route_update_response.RouteUpdateResponseSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

RouteUpdateResponse message schema used in serialization/deserialization.

class Meta[source]

Bases: object

RouteUpdateResponseSchema metadata.

model_class

alias of aries_cloudagent.protocols.routing.v1_0.messages.route_update_response.RouteUpdateResponse

updated