Source code for annofabapi.pydantic_models.input_data

"""


No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

Do not edit the class manually.
"""

from __future__ import annotations

import json
import pprint
import re  # noqa: F401
from typing import Any, ClassVar, Dict, List, Set

from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
from typing_extensions import Self

from annofabapi.pydantic_models.system_metadata import SystemMetadata




class InputData(BaseModel):
    """
    入力データの情報を表すデータ構造です。
    """

    input_data_id: StrictStr = Field(description="入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) ")
    project_id: StrictStr = Field(description="プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) ")
    organization_id: StrictStr = Field(description="組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID) ")
    input_data_set_id: StrictStr = Field(
        description="入力データセットID(システム内部用のプロパティ)。[値の制約についてはこちら。](#section/API-Convention/APIID) "
    )
    input_data_name: StrictStr = Field(description="入力データ名")
    input_data_path: StrictStr = Field(
        description="入力データの実体が保存されたURLです。 URLスキームが s3 もしくは https であるもののみをサポートしています。 "
    )
    url: StrictStr | None = Field(default=None, description="システム内部用のプロパティ")
    etag: StrictStr | None = Field(
        default=None, description="[HTTPレスポンスヘッダー ETag](https://developer.mozilla.org/ja/docs/Web/HTTP/Headers/ETag)に相当する値です。 "
    )
    original_input_data_path: StrictStr | None = Field(default=None, description="システム内部用のプロパティ ")
    updated_datetime: str = Field(description="更新日時")
    sign_required: StrictBool = Field(description="CloudFrontのSignedCookieを使ったプライベートストレージを利用するかどうか ")
    metadata: Dict[str, StrictStr] = Field(description="ユーザーが自由に登録できるkey-value型のメタデータです。 ")
    system_metadata: SystemMetadata
    __properties: ClassVar[List[str]] = [
        "input_data_id",
        "project_id",
        "organization_id",
        "input_data_set_id",
        "input_data_name",
        "input_data_path",
        "url",
        "etag",
        "original_input_data_path",
        "updated_datetime",
        "sign_required",
        "metadata",
        "system_metadata",
    ]

    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) -> Self | None:
        """Create an instance of InputData 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 system_metadata
        if self.system_metadata:
            _dict["system_metadata"] = self.system_metadata.to_dict()
        return _dict




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

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

        _obj = cls.model_validate(
            {
                "input_data_id": obj.get("input_data_id"),
                "project_id": obj.get("project_id"),
                "organization_id": obj.get("organization_id"),
                "input_data_set_id": obj.get("input_data_set_id"),
                "input_data_name": obj.get("input_data_name"),
                "input_data_path": obj.get("input_data_path"),
                "url": obj.get("url"),
                "etag": obj.get("etag"),
                "original_input_data_path": obj.get("original_input_data_path"),
                "updated_datetime": obj.get("updated_datetime"),
                "sign_required": obj.get("sign_required"),
                "metadata": obj.get("metadata"),
                "system_metadata": SystemMetadata.from_dict(obj["system_metadata"]) if obj.get("system_metadata") is not None else None,
            }
        )
        return _obj