"""keylist-query message used to request list of keys handled by mediator."""
from marshmallow import fields
from .....messaging.agent_message import AgentMessage, AgentMessageSchema
from ..message_types import KEYLIST_QUERY, PROTOCOL_PACKAGE
from .inner.keylist_query_paginate import (
KeylistQueryPaginate,
KeylistQueryPaginateSchema,
)
HANDLER_CLASS = f"{PROTOCOL_PACKAGE}.handlers.keylist_query_handler.KeylistQueryHandler"
[docs]class KeylistQuery(AgentMessage):
"""Class representing a keylist query message."""
def __init__(
self,
*,
filter: dict = None,
paginate: KeylistQueryPaginate = None,
**kwargs,
):
"""
Initialize keylist query object.
Args:
filter: Filter for query
paginate: Pagination rules
"""
super(KeylistQuery, self).__init__(**kwargs)
self.filter = filter
self.paginate = paginate
[docs]class KeylistQuerySchema(AgentMessageSchema):
"""Keylist query schema class."""
filter = fields.Dict(
required=False, description="Query dictionary object", example={"filter": {}}
)
paginate = fields.Nested(
KeylistQueryPaginateSchema(), required=False, description="Pagination info"
)