Module `mydata_did.v1_0.messages.data_agreement_terminate_ack`

Expand source code

from marshmallow import EXCLUDE

from aries_cloudagent.messaging.ack.message import Ack, AckSchema

from ..message_types import DATA_AGREEMENT_TERMINATION_TERMINATE_ACK, PROTOCOL_PACKAGE

HANDLER_CLASS = (
    f"{PROTOCOL_PACKAGE}.handlers.data_agreement_termination_ack_handler.DataAgreementTerminationAckHandler"
)


class DataAgreementTerminationAck(Ack):
    """Base class representing an explicit ack message for data agreement termination protocol."""

    class Meta:
        """DataAgreementTerminationAck metadata."""

        handler_class = HANDLER_CLASS
        message_type = DATA_AGREEMENT_TERMINATION_TERMINATE_ACK
        schema_class = "DataAgreementTerminationAckSchema"

    def __init__(self, status: str = None, **kwargs):
        """
        Initialize an explicit ack message instance.

        Args:
            status: Status (default OK)

        """
        super().__init__(status, **kwargs)


class DataAgreementTerminationAckSchema(AckSchema):
    """Schema for DataAgreementTerminationAck class."""

    class Meta:
        """DataAgreementTerminationAck schema metadata."""

        model_class = DataAgreementTerminationAck
        unknown = EXCLUDE

Classes

class DataAgreementTerminationAck (status: str = None, **kwargs)

Base class representing an explicit ack message for data agreement termination protocol.

Initialize an explicit ack message instance.

Args

status: Status (default OK)

Expand source code

class DataAgreementTerminationAck(Ack):
    """Base class representing an explicit ack message for data agreement termination protocol."""

    class Meta:
        """DataAgreementTerminationAck metadata."""

        handler_class = HANDLER_CLASS
        message_type = DATA_AGREEMENT_TERMINATION_TERMINATE_ACK
        schema_class = "DataAgreementTerminationAckSchema"

    def __init__(self, status: str = None, **kwargs):
        """
        Initialize an explicit ack message instance.

        Args:
            status: Status (default OK)

        """
        super().__init__(status, **kwargs)

Ancestors

aries_cloudagent.messaging.ack.message.Ack
aries_cloudagent.messaging.agent_message.AgentMessage
aries_cloudagent.messaging.models.base.BaseModel
abc.ABC

Class variables

var Meta: DataAgreementTerminationAck metadata.

class DataAgreementTerminationAckSchema (*args, **kwargs)

Schema for DataAgreementTerminationAck class.

Initialize an instance of AgentMessageSchema.

Raises

TypeError: If Meta.model_class has not been set

Expand source code

class DataAgreementTerminationAckSchema(AckSchema):
    """Schema for DataAgreementTerminationAck class."""

    class Meta:
        """DataAgreementTerminationAck schema metadata."""

        model_class = DataAgreementTerminationAck
        unknown = EXCLUDE

Ancestors

aries_cloudagent.messaging.ack.message.AckSchema
aries_cloudagent.messaging.agent_message.AgentMessageSchema
aries_cloudagent.messaging.models.base.BaseModelSchema
marshmallow.schema.Schema
marshmallow.base.SchemaABC

Class variables

var Meta: DataAgreementTerminationAck schema metadata.
var opts