Source code for ubii.proto.v1.sessions.session_pb_plus

"""
@generated by codestare-proto-plus.  Do not edit manually!
"""
from builtins import (
    bool,
    str,
)

from proto import (
    BOOL,
    ENUM,
    Enum,
    Field,
    MESSAGE,
    RepeatedField,
    STRING,
    module,
)

from proto.message import (
    Message,
)

from typing import (
    MutableSequence,
)

from ubii.proto.v1.processing.processingModule_pb_plus import (
    ProcessingModule,
)

from ubii.proto.v1.sessions.ioMappings_pb_plus import (
    IOMapping,
)


__protobuf__ = module(
    package="ubii.proto.v1.sessions",
    marshal="ubii.proto.v1",
    manifest={
        "Session",
        "SessionList",
        "SessionStatus",
    }
)


class SessionStatus(Enum):
    CREATED = 0
    """"""

    RUNNING = 1
    """"""

    PAUSED = 2
    """"""

    STOPPED = 3
    """"""

class Session(Message):
    """
    Attributes:
        id (proto.fields.Field): :obj:`~proto.fields.Field` of type
            :obj:`~proto.primitives.ProtoType.STRING`
        name (proto.fields.Field): :obj:`~proto.fields.Field` of type
            :obj:`~proto.primitives.ProtoType.STRING`
        processing_modules (proto.fields.RepeatedField): :obj:`~proto.fields.RepeatedField` of type
            :obj:`~ubii.proto.v1.processing.processingModule_pb_plus.ProcessingModule`
        io_mappings (proto.fields.RepeatedField): :obj:`~proto.fields.RepeatedField` of type
            :obj:`~ubii.proto.v1.sessions.ioMappings_pb_plus.IOMapping`
        tags (proto.fields.RepeatedField): :obj:`~proto.fields.RepeatedField` of type
            :obj:`~proto.primitives.ProtoType.STRING`
        description (proto.fields.Field): :obj:`~proto.fields.Field` of type
            :obj:`~proto.primitives.ProtoType.STRING`
        authors (proto.fields.RepeatedField): :obj:`~proto.fields.RepeatedField` of type
            :obj:`~proto.primitives.ProtoType.STRING`
        status (proto.fields.Field): :obj:`~proto.fields.Field` of type :obj:`~.SessionStatus`
        editable (proto.fields.Field): :obj:`~proto.fields.Field` of type
            :obj:`~proto.primitives.ProtoType.BOOL`
    """

    id: str = Field(
        STRING,
        number=1,
    )
    name: str = Field(
        STRING,
        number=2,
    )
    processing_modules: MutableSequence[ProcessingModule] = RepeatedField(
        MESSAGE,
        number=3,
        message=ProcessingModule,
    )
    io_mappings: MutableSequence[IOMapping] = RepeatedField(
        MESSAGE,
        number=4,
        message=IOMapping,
    )
    tags: MutableSequence[str] = RepeatedField(
        STRING,
        number=5,
    )
    description: str = Field(
        STRING,
        number=6,
    )
    authors: MutableSequence[str] = RepeatedField(
        STRING,
        number=7,
    )
    status: SessionStatus = Field(
        ENUM,
        number=8,
        enum=SessionStatus,
    )
    editable: bool = Field(
        BOOL,
        number=9,
    )


class SessionList(Message):
    """
    Attributes:
        elements (proto.fields.RepeatedField): :obj:`~proto.fields.RepeatedField` of type
            :obj:`~.Session`
    """

    elements: MutableSequence[Session] = RepeatedField(
        MESSAGE,
        number=1,
        message=Session,
    )