Source code for arize._generated.api_client.models.service_key_bot_user
# 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 pydantic import BaseModel, ConfigDict, Field, StrictStr
from typing import Any, ClassVar, Dict, List
from typing_extensions import Annotated
from arize._generated.api_client.models.service_key_bot_user_org_assignment import ServiceKeyBotUserOrgAssignment
from arize._generated.api_client.models.user_role_assignment import UserRoleAssignment
from typing import Optional, Set
from typing_extensions import Self
[docs]
class ServiceKeyBotUser(BaseModel):
"""
ServiceKeyBotUser
""" # noqa: E501
id: StrictStr = Field(description="Global ID of the bot user.")
name: StrictStr = Field(description="Display name of the bot user.")
account_role: UserRoleAssignment = Field(description="Account-level role assigned to the bot user. Always present — defaults are resolved server-side.")
organizations: Annotated[List[ServiceKeyBotUserOrgAssignment], Field(min_length=1)] = Field(description="Organization access assignments for the service account, each containing nested space assignments.")
__properties: ClassVar[List[str]] = ["id", "name", "account_role", "organizations"]
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) -> Optional[Self]:
"""Create an instance of ServiceKeyBotUser 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 account_role
if self.account_role:
_dict['account_role'] = self.account_role.to_dict()
# override the default output from pydantic by calling `to_dict()` of each item in organizations (list)
_items = []
if self.organizations:
for _item_organizations in self.organizations:
if _item_organizations:
_items.append(_item_organizations.to_dict())
_dict['organizations'] = _items
return _dict
[docs]
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"""Create an instance of ServiceKeyBotUser 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 ServiceKeyBotUser) in the input: " + _key)
_obj = cls.model_validate({
"id": obj.get("id"),
"name": obj.get("name"),
"account_role": UserRoleAssignment.from_dict(obj["account_role"]) if obj.get("account_role") is not None else None,
"organizations": [ServiceKeyBotUserOrgAssignment.from_dict(_item) for _item in obj["organizations"]] if obj.get("organizations") is not None else None
})
return _obj