Module mydata_did.v1_0.decorators.data_agreement_context_decorator

Expand source code
from aries_cloudagent.messaging.models.base import BaseModel, BaseModelSchema
from marshmallow import fields, EXCLUDE, validate


class DataAgreementContextDecorator(BaseModel):
    """
    Class representing a data agreement context decorator.
    """

    class Meta:
        """DataAgreementContextDecorator metadata."""

        schema_class = "DataAgreementContextDecoratorSchema"

    def __init__(
        self,
        *,
        message_type: str = None,
        message: dict = None,
        **kwargs
    ):
        """
        Initialize a DataAgreementContextDecorator instance.

        Args:
            message_type: The type of the message.
            message: The message.
            kwargs: The keyword arguments

        """
        super().__init__(**kwargs)
        self.message_type = message_type
        self.message = message


class DataAgreementContextDecoratorSchema(BaseModelSchema):
    """
    DataAgreementContextDecorator schema.
    """

    class Meta:
        """DataAgreementContextDecoratorSchema metadata."""

        model_class = DataAgreementContextDecorator
        unknown = EXCLUDE

    message_type = fields.Str(
        required=False,
        description="The type of the message.",
        example="protocol",
        validate=validate.OneOf(["protocol", "non-protocol"]),
    )
    message = fields.Dict(
        required=False,
        description="The message.",
        example={"data_agreement_id": "12345678-1234-1234-1234-123456789012"},
    )

Classes

class DataAgreementContextDecorator (*, message_type: str = None, message: dict = None, **kwargs)

Class representing a data agreement context decorator.

Initialize a DataAgreementContextDecorator instance.

Args

message_type
The type of the message.
message
The message.
kwargs
The keyword arguments
Expand source code
class DataAgreementContextDecorator(BaseModel):
    """
    Class representing a data agreement context decorator.
    """

    class Meta:
        """DataAgreementContextDecorator metadata."""

        schema_class = "DataAgreementContextDecoratorSchema"

    def __init__(
        self,
        *,
        message_type: str = None,
        message: dict = None,
        **kwargs
    ):
        """
        Initialize a DataAgreementContextDecorator instance.

        Args:
            message_type: The type of the message.
            message: The message.
            kwargs: The keyword arguments

        """
        super().__init__(**kwargs)
        self.message_type = message_type
        self.message = message

Ancestors

  • aries_cloudagent.messaging.models.base.BaseModel
  • abc.ABC

Class variables

var Meta

DataAgreementContextDecorator metadata.

class DataAgreementContextDecoratorSchema (*args, **kwargs)

DataAgreementContextDecorator schema.

Initialize BaseModelSchema.

Raises

TypeError
If model_class is not set on Meta
Expand source code
class DataAgreementContextDecoratorSchema(BaseModelSchema):
    """
    DataAgreementContextDecorator schema.
    """

    class Meta:
        """DataAgreementContextDecoratorSchema metadata."""

        model_class = DataAgreementContextDecorator
        unknown = EXCLUDE

    message_type = fields.Str(
        required=False,
        description="The type of the message.",
        example="protocol",
        validate=validate.OneOf(["protocol", "non-protocol"]),
    )
    message = fields.Dict(
        required=False,
        description="The message.",
        example={"data_agreement_id": "12345678-1234-1234-1234-123456789012"},
    )

Ancestors

  • aries_cloudagent.messaging.models.base.BaseModelSchema
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC

Class variables

var Meta

DataAgreementContextDecoratorSchema metadata.

var opts