acapy_agent.protocols.routing.v1_0.models package

Submodules

acapy_agent.protocols.routing.v1_0.models.route_record module

An object for containing information on an individual route.

class acapy_agent.protocols.routing.v1_0.models.route_record.RouteRecord(*, record_id: str | None = None, role: str | None = None, connection_id: str | None = None, wallet_id: str | None = None, recipient_key: str | None = None, **kwargs)[source]

Bases: BaseRecord

Class representing stored route information.

class Meta[source]

Bases: object

RouteRecord metadata.

schema_class = 'RouteRecordSchema'

RECORD_ID_NAME = 'record_id'

RECORD_TYPE = 'forward_route'

ROLE_CLIENT = 'client'

ROLE_SERVER = 'server'

TAG_NAMES = {'connection_id', 'recipient_key', 'role', 'wallet_id'}

property record_id: str: Get record ID.

property record_value: dict: Accessor for JSON record value.

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 acapy_agent.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
kwargs – Additional keyword arguments

Raises:

ValidationError – If any of the fields do not validate