aries_cloudagent.protocols.routing.v1_0.models package
Submodules
aries_cloudagent.protocols.routing.v1_0.models.route_record module
An object for containing information on an individual route.
- class aries_cloudagent.protocols.routing.v1_0.models.route_record.RouteRecord(*, record_id: Optional[str] = None, role: Optional[str] = None, connection_id: Optional[str] = None, wallet_id: Optional[str] = None, recipient_key: Optional[str] = None, **kwargs)[source]
Bases:
BaseRecord
Class representing stored route information.
- RECORD_ID_NAME = 'record_id'
- RECORD_TYPE = 'forward_route'
- ROLE_CLIENT = 'client'
- ROLE_SERVER = 'server'
- TAG_NAMES = {'connection_id', 'recipient_key', 'role', 'wallet_id'}
- async classmethod retrieve_by_connection_id(session: ProfileSession, connection_id: str) RouteRecord [source]
Retrieve a route record by connection ID.
- Parameters
session (ProfileSession) – session
connection_id (str) – ID to look up
- Returns
retrieved route record
- Return type
- async classmethod retrieve_by_recipient_key(session: ProfileSession, recipient_key: str) RouteRecord [source]
Retrieve a route record by recipient key.
- Parameters
session (ProfileSession) – session
recipient_key (str) – key to look up
- Returns
retrieved route record
- Return type
- class aries_cloudagent.protocols.routing.v1_0.models.route_record.RouteRecordSchema(*args: Any, **kwargs: Any)[source]
Bases:
BaseRecordSchema
RouteRecord schema.
- class Meta[source]
Bases:
object
RouteRecordSchema metadata.
- model_class
alias of
RouteRecord
- validate_fields(data, **kwargs)
Validate schema fields.
- Parameters
data – The data to validate
- Raises
ValidationError – If any of the fields do not validate