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

# 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, StrictBool, StrictStr
from typing import Any, ClassVar, Dict, List
from typing import Optional, Set
from typing_extensions import Self



class SpanDeleteResponse(BaseModel):
    """
    Result of a DELETE /v2/spans request.  `deleted_span_ids` lists every span ID confirmed deleted. `not_deleted_span_ids` lists every requested span ID that was **not** deleted.  `completed` indicates whether the server fully processed all data for the request — **not** whether all spans were found and deleted. A span may appear in `not_deleted_span_ids` even when `completed` is `true` if it was not found in the system (never ingested or already deleted).  When `completed` is `true`, every requested ID appears in exactly one of `deleted_span_ids` or `not_deleted_span_ids`. No retry is needed.  When `completed` is `false`, the server could not fully process all data. Some IDs in `not_deleted_span_ids` may still be deletable — retry the original full request to resolve them. The delete is idempotent. 
    """ # noqa: E501
    completed: StrictBool = Field(description="`true` when the server fully processed all data for the request — both lists are complete and no retry is needed. `false` when processing could not fully complete; retry the original request. Note: `completed` reflects whether all data was processed, not whether all requested spans existed. ")
    deleted_span_ids: List[StrictStr] = Field(description="Span IDs confirmed deleted in this request.")
    not_deleted_span_ids: List[StrictStr] = Field(description="Requested span IDs that were not deleted. When `completed` is `true`, these were not found in the system (never ingested or already deleted). When `completed` is `false`, some IDs may not have been reached — retry to resolve them. ")
    __properties: ClassVar[List[str]] = ["completed", "deleted_span_ids", "not_deleted_span_ids"]

    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 SpanDeleteResponse 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,
        )
        return _dict




    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of SpanDeleteResponse 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 SpanDeleteResponse) in the input: " + _key)

        _obj = cls.model_validate({
            "completed": obj.get("completed"),
            "deleted_span_ids": obj.get("deleted_span_ids"),
            "not_deleted_span_ids": obj.get("not_deleted_span_ids")
        })
        return _obj