Source code for arize._generated.api_client.models.annotation_queue

# coding: utf-8

"""
    Arize REST API

    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 

    The version of the OpenAPI document: 2.0.0
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""  # noqa: E501


from __future__ import annotations
import pprint
import re  # noqa: F401
import json

from datetime import datetime
from pydantic import BaseModel, ConfigDict, Field, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from arize._generated.api_client.models.annotation_config import AnnotationConfig
from arize._generated.api_client.models.annotator_user import AnnotatorUser
from typing import Optional, Set
from typing_extensions import Self



class AnnotationQueue(BaseModel):
    """
    AnnotationQueue
    """ # noqa: E501
    id: StrictStr = Field(description="The unique identifier for the annotation queue")
    name: StrictStr = Field(description="The name of the annotation queue")
    space_id: StrictStr = Field(description="The space id the annotation queue belongs to")
    instructions: Optional[StrictStr] = Field(default=None, description="The instructions for the annotation queue")
    annotation_configs: Optional[List[AnnotationConfig]] = Field(default=None, description="The annotation configs associated with this queue")
    annotators: List[AnnotatorUser] = Field(description="Users assigned as annotators to this queue")
    created_at: datetime = Field(description="The timestamp for when the annotation queue was created")
    updated_at: datetime = Field(description="The timestamp for when the annotation queue was last updated")
    __properties: ClassVar[List[str]] = ["id", "name", "space_id", "instructions", "annotation_configs", "annotators", "created_at", "updated_at"]

    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )




    def to_str(self) -> str:
        """Returns the string representation of the model using alias"""
        return pprint.pformat(self.model_dump(by_alias=True))




    def to_json(self) -> str:
        """Returns the JSON representation of the model using alias"""
        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
        return json.dumps(self.to_dict())




    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of AnnotationQueue from a JSON string"""
        return cls.from_dict(json.loads(json_str))




    def to_dict(self) -> Dict[str, Any]:
        """Return the dictionary representation of the model using alias.

        This has the following differences from calling pydantic's
        `self.model_dump(by_alias=True)`:

        * `None` is only added to the output dict for nullable fields that
          were set at model initialization. Other fields with value `None`
          are ignored.
        """
        excluded_fields: Set[str] = set([
        ])

        _dict = self.model_dump(
            by_alias=True,
            exclude=excluded_fields,
            exclude_none=True,
        )
        # override the default output from pydantic by calling `to_dict()` of each item in annotation_configs (list)
        _items = []
        if self.annotation_configs:
            for _item_annotation_configs in self.annotation_configs:
                if _item_annotation_configs:
                    _items.append(_item_annotation_configs.to_dict())
            _dict['annotation_configs'] = _items
        # override the default output from pydantic by calling `to_dict()` of each item in annotators (list)
        _items = []
        if self.annotators:
            for _item_annotators in self.annotators:
                if _item_annotators:
                    _items.append(_item_annotators.to_dict())
            _dict['annotators'] = _items
        # set to None if instructions (nullable) is None
        # and model_fields_set contains the field
        if self.instructions is None and "instructions" in self.model_fields_set:
            _dict['instructions'] = None

        return _dict




    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of AnnotationQueue from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        # raise errors for additional fields in the input
        for _key in obj.keys():
            if _key not in cls.__properties:
                raise ValueError("Error due to additional fields (not defined in AnnotationQueue) in the input: " + _key)

        _obj = cls.model_validate({
            "id": obj.get("id"),
            "name": obj.get("name"),
            "space_id": obj.get("space_id"),
            "instructions": obj.get("instructions"),
            "annotation_configs": [AnnotationConfig.from_dict(_item) for _item in obj["annotation_configs"]] if obj.get("annotation_configs") is not None else None,
            "annotators": [AnnotatorUser.from_dict(_item) for _item in obj["annotators"]] if obj.get("annotators") is not None else None,
            "created_at": obj.get("created_at"),
            "updated_at": obj.get("updated_at")
        })
        return _obj