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: str = None, msg: 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
aries_cloudagent.protocols.routing.v1_0.messages.forward.
ForwardSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessageSchema
Forward message schema used in serialization/deserialization.
-
handle_str_message
(data, **kwargs)[source]¶ Accept string value for msg, as produced by previous implementation.
-
msg
= <fields.Dict(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid mapping type.'})>¶
-
to
= <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶
-
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: dict = None, paginate: 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
aries_cloudagent.protocols.routing.v1_0.messages.route_query_request.
RouteQueryRequestSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessageSchema
RouteQueryRequest message schema used in serialization/deserialization.
-
class
Meta
[source]¶ Bases:
object
RouteQueryRequestSchema metadata.
-
model_class
¶ alias of
RouteQueryRequest
-
unknown
= 'exclude'¶
-
-
filter
= <fields.Dict(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=True, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid mapping type.'})>¶
-
paginate
= <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=True, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶
-
class
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: Sequence[aries_cloudagent.protocols.routing.v1_0.models.route_query_result.RouteQueryResult] = None, paginated: 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
aries_cloudagent.protocols.routing.v1_0.messages.route_query_response.
RouteQueryResponseSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessageSchema
RouteQueryResponse message schema used in serialization/deserialization.
-
class
Meta
[source]¶ Bases:
object
RouteQueryResponseSchema metadata.
-
model_class
¶ alias of
RouteQueryResponse
-
unknown
= 'exclude'¶
-
-
paginated
= <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶
-
routes
= <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>¶
-
class
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: 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
aries_cloudagent.protocols.routing.v1_0.messages.route_update_request.
RouteUpdateRequestSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessageSchema
RouteUpdateRequest message schema used in serialization/deserialization.
-
class
Meta
[source]¶ Bases:
object
RouteUpdateRequestSchema metadata.
-
model_class
¶ alias of
RouteUpdateRequest
-
unknown
¶ Used by autodoc_mock_imports.
-
-
updates
¶ Used by autodoc_mock_imports.
-
class
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: 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
aries_cloudagent.protocols.routing.v1_0.messages.route_update_response.
RouteUpdateResponseSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessageSchema
RouteUpdateResponse message schema used in serialization/deserialization.
-
class
Meta
[source]¶ Bases:
object
RouteUpdateResponseSchema metadata.
-
model_class
¶ alias of
RouteUpdateResponse
-
unknown
= 'exclude'¶
-
-
updated
= <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>¶
-
class