aries_cloudagent.messaging.routing.models package¶

Submodules¶

aries_cloudagent.messaging.routing.models.paginate module¶

An object for containing the request pagination information.

class aries_cloudagent.messaging.routing.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.messaging.routing.models.paginate.PaginateSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

Paginate schema.

class Meta[source]¶

Bases: object

PaginateSchema metadata.

model_class = 'Paginate'¶

limit = <fields.Integer(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.', 'invalid': 'Not a valid integer.'})>¶

offset = <fields.Integer(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.', 'invalid': 'Not a valid integer.'})>¶

aries_cloudagent.messaging.routing.models.paginated module¶

An object for containing the response pagination information.

class aries_cloudagent.messaging.routing.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.messaging.routing.models.paginated.PaginatedSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

Paginated schema.

class Meta[source]¶

Bases: object

PaginatedSchema metadata.

model_class = 'Paginated'¶

end = <fields.Integer(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.', 'invalid': 'Not a valid integer.'})>¶

limit = <fields.Integer(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.', 'invalid': 'Not a valid integer.'})>¶

start = <fields.Integer(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.', 'invalid': 'Not a valid integer.'})>¶

total = <fields.Integer(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.', 'invalid': 'Not a valid integer.'})>¶

aries_cloudagent.messaging.routing.models.route_query_result module¶

An object for containing returned route information.

class aries_cloudagent.messaging.routing.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.messaging.routing.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 = 'RouteQueryResult'¶

recipient_key = <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.messaging.routing.models.route_record module¶

An object for containing information on an individual route.

class aries_cloudagent.messaging.routing.models.route_record.RouteRecord(*, record_id: str = None, connection_id: str = None, recipient_key: str = None, created_at: str = None, updated_at: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModel

Class representing stored route information.

class Meta[source]¶

Bases: object

RouteRecord metadata.

schema_class = 'RouteRecordSchema'¶

class aries_cloudagent.messaging.routing.models.route_record.RouteRecordSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

RouteRecord schema.

class Meta[source]¶

Bases: object

RouteRecordSchema metadata.

model_class = 'RouteRecord'¶

connection_id¶: Used by autodoc_mock_imports.

created_at¶: Used by autodoc_mock_imports.

recipient_key¶: Used by autodoc_mock_imports.

record_id¶: Used by autodoc_mock_imports.

updated_at¶: Used by autodoc_mock_imports.

aries_cloudagent.messaging.routing.models.route_update module¶

An object for containing route information to be updated.

class aries_cloudagent.messaging.routing.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.messaging.routing.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 = 'RouteUpdate'¶

action¶: Used by autodoc_mock_imports.

recipient_key¶: Used by autodoc_mock_imports.

aries_cloudagent.messaging.routing.models.route_updated module¶

An object for containing updated route information.

class aries_cloudagent.messaging.routing.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.