Source code for annofabapi.pydantic_models.put_organization_plugin_request
"""
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, StrictStr
from typing_extensions import Self
from annofabapi.pydantic_models.plugin_detail import PluginDetail
[docs]
class PutOrganizationPluginRequest(BaseModel):
"""
PutOrganizationPluginRequest
"""
plugin_name: StrictStr | None = Field(
default=None, description="プラグインの名前です。 プラグイン一覧や、プロジェクトで使うプラグインを選ぶときなどに表示されます。 "
)
description: StrictStr | None = Field(
default=None, description="プラグインの説明です。 プラグイン一覧や、プロジェクトで使うプラグインを選ぶときなどに表示されます。 "
)
project_extra_data_kinds: List[StrictStr] | None = Field(
default=None, description="プラグインが適用されたプロジェクトで使用可能となるProjectExtraDataKindのId列。 "
)
detail: PluginDetail
last_updated_datetime: str | None = Field(default=None, description="新規作成時は未指定、更新時は必須(更新前の日時) ")
__properties: ClassVar[List[str]] = ["plugin_name", "description", "project_extra_data_kinds", "detail", "last_updated_datetime"]
model_config = ConfigDict(
populate_by_name=True,
validate_assignment=True,
protected_namespaces=(),
)
[docs]
def to_str(self) -> str:
"""Returns the string representation of the model using alias"""
return pprint.pformat(self.model_dump(by_alias=True))
[docs]
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())
[docs]
@classmethod
def from_json(cls, json_str: str) -> Self | None:
"""Create an instance of PutOrganizationPluginRequest from a JSON string"""
return cls.from_dict(json.loads(json_str))
[docs]
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 detail
if self.detail:
_dict["detail"] = self.detail.to_dict()
return _dict
[docs]
@classmethod
def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
"""Create an instance of PutOrganizationPluginRequest from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
_obj = cls.model_validate(
{
"plugin_name": obj.get("plugin_name"),
"description": obj.get("description"),
"project_extra_data_kinds": obj.get("project_extra_data_kinds"),
"detail": PluginDetail.from_dict(obj["detail"]) if obj.get("detail") is not None else None,
"last_updated_datetime": obj.get("last_updated_datetime"),
}
)
return _obj