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: int = None, offset: 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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

Paginate schema.

class Meta[source]¶

Bases: object

PaginateSchema metadata.

model_class¶: alias of Paginate

unknown¶: Used by autodoc_mock_imports.

limit¶: Used by autodoc_mock_imports.

offset¶: Used by autodoc_mock_imports.

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: int = None, end: int = None, limit: int = None, total: 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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

Paginated schema.

class Meta[source]¶

Bases: object

PaginatedSchema metadata.

model_class¶: alias of Paginated

unknown¶: Used by autodoc_mock_imports.

end¶: Used by autodoc_mock_imports.

limit¶: Used by autodoc_mock_imports.

start¶: Used by autodoc_mock_imports.

total¶: Used by autodoc_mock_imports.

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: 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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

RouteQueryResult schema.

class Meta[source]¶

Bases: object

RouteQueryResultSchema metadata.

model_class¶: alias of RouteQueryResult

unknown¶: Used by autodoc_mock_imports.

recipient_key¶: Used by autodoc_mock_imports.

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: str = None, role: str = None, connection_id: str = None, wallet_id: str = None, recipient_key: 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'}¶

record_id¶: Get record ID.

record_value¶: Accessor for JSON record value.

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

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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base_record.BaseRecordSchema

RouteRecord schema.

class Meta[source]¶

Bases: object

RouteRecordSchema metadata.

model_class¶: alias of RouteRecord

unknown¶: Used by autodoc_mock_imports.

connection_id¶: Used by autodoc_mock_imports.

recipient_key¶: Used by autodoc_mock_imports.

record_id¶: Used by autodoc_mock_imports.

role¶: Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]¶

Validate schema fields.

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

wallet_id¶: Used by autodoc_mock_imports.

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: str = None, action: 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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

RouteUpdate schema.

class Meta[source]¶

Bases: object

RouteUpdateSchema metadata.

model_class¶: alias of RouteUpdate

unknown¶: Used by autodoc_mock_imports.

action¶: Used by autodoc_mock_imports.

recipient_key¶: Used by autodoc_mock_imports.

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: str = None, action: str = None, result: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModel

Class representing a route update response.

class Meta[source]¶

Bases: object

RouteUpdated metadata.