aries_cloudagent.protocols.routing.v1_0.models package

Submodules

aries_cloudagent.protocols.routing.v1_0.models.paginate module

An object for containing the request pagination information.

class aries_cloudagent.protocols.routing.v1_0.models.paginate.Paginate(*, limit: Optional[int] = None, offset: Optional[int] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModel

Class representing the pagination details of a request.

class Meta[source]

Bases: object

Paginate metadata.

schema_class = 'PaginateSchema'

class aries_cloudagent.protocols.routing.v1_0.models.paginate.PaginateSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Paginate schema.

class Meta[source]

Bases: object

PaginateSchema metadata.

model_class: alias of aries_cloudagent.protocols.routing.v1_0.models.paginate.Paginate

limit

offset

aries_cloudagent.protocols.routing.v1_0.models.paginated module

An object for containing the response pagination information.

class aries_cloudagent.protocols.routing.v1_0.models.paginated.Paginated(*, start: Optional[int] = None, end: Optional[int] = None, limit: Optional[int] = None, total: Optional[int] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModel

Class representing the pagination details of a response.

class Meta[source]

Bases: object

Paginated metadata.

schema_class = 'PaginatedSchema'

class aries_cloudagent.protocols.routing.v1_0.models.paginated.PaginatedSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Paginated schema.

class Meta[source]

Bases: object

PaginatedSchema metadata.

model_class: alias of aries_cloudagent.protocols.routing.v1_0.models.paginated.Paginated

end

limit

start

total

aries_cloudagent.protocols.routing.v1_0.models.route_query_result module

An object for containing returned route information.

class aries_cloudagent.protocols.routing.v1_0.models.route_query_result.RouteQueryResult(*, recipient_key: Optional[str] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModel

Class representing route information returned by a route query.

class Meta[source]

Bases: object

RouteQueryResult metadata.

schema_class = 'RouteQueryResultSchema'

class aries_cloudagent.protocols.routing.v1_0.models.route_query_result.RouteQueryResultSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

RouteQueryResult schema.

class Meta[source]

Bases: object

RouteQueryResultSchema metadata.

model_class: alias of aries_cloudagent.protocols.routing.v1_0.models.route_query_result.RouteQueryResult

recipient_key

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: aries_cloudagent.messaging.models.base_record.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: aries_cloudagent.core.profile.ProfileSession, connection_id: str) → aries_cloudagent.protocols.routing.v1_0.models.route_record.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

RouteRecord

async classmethod retrieve_by_recipient_key(session: aries_cloudagent.core.profile.ProfileSession, recipient_key: str) → aries_cloudagent.protocols.routing.v1_0.models.route_record.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

RouteRecord

class aries_cloudagent.protocols.routing.v1_0.models.route_record.RouteRecordSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

RouteRecord schema.

class Meta[source]

Bases: object

RouteRecordSchema metadata.

model_class: alias of aries_cloudagent.protocols.routing.v1_0.models.route_record.RouteRecord

connection_id

recipient_key

record_id

role

validate_fields(data, **kwargs)

Validate schema fields.

Parameters: data – The data to validate
Raises: ValidationError – If any of the fields do not validate

wallet_id

aries_cloudagent.protocols.routing.v1_0.models.route_update module

An object for containing route information to be updated.

class aries_cloudagent.protocols.routing.v1_0.models.route_update.RouteUpdate(*, recipient_key: Optional[str] = None, action: Optional[str] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModel

Class representing a route update request.

ACTION_CREATE = 'create'

ACTION_DELETE = 'delete'

class Meta[source]

Bases: object

RouteUpdate metadata.

schema_class = 'RouteUpdateSchema'

class aries_cloudagent.protocols.routing.v1_0.models.route_update.RouteUpdateSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

RouteUpdate schema.

class Meta[source]

Bases: object

RouteUpdateSchema metadata.

model_class: alias of aries_cloudagent.protocols.routing.v1_0.models.route_update.RouteUpdate

action

recipient_key

aries_cloudagent.protocols.routing.v1_0.models.route_updated module

An object for containing updated route information.

class aries_cloudagent.protocols.routing.v1_0.models.route_updated.RouteUpdated(*, recipient_key: Optional[str] = None, action: Optional[str] = None, result: Optional[str] = None, **kwargs)[source]