# coding: utf-8

"""
    Mixpeek API

    This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.

    The version of the OpenAPI document: 1.3.0
    Contact: info@mixpeek.com
    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, Optional
from mixpeek.models.aggregation_function import AggregationFunction
from typing import Optional, Set
from typing_extensions import Self

class AggregationOperation(BaseModel):
    """
    Configuration for an aggregation operation.  Defines a calculation to perform on grouped data.  Requirements:     - function: REQUIRED, the aggregation function to apply     - field: REQUIRED for most functions (except COUNT), field to aggregate     - alias: REQUIRED, name for the result in output  Examples:     - Count: AggregationOperation(function=\"count\", alias=\"total_count\")     - Sum: AggregationOperation(function=\"sum\", field=\"metadata.views\", alias=\"total_views\")     - Average: AggregationOperation(function=\"avg\", field=\"metadata.duration\", alias=\"avg_duration\")
    """ # noqa: E501
    function: AggregationFunction = Field(description="The aggregation function to apply. Different functions require different field types: COUNT: no field required. SUM/AVG: numeric fields only. MIN/MAX: numeric or date fields. COUNT_DISTINCT: any field type.")
    var_field: Optional[StrictStr] = Field(default=None, description="The field to aggregate. REQUIRED for all functions except COUNT. NOT REQUIRED for COUNT (counts documents). Supports dot notation for nested fields. Field type must be compatible with function.", alias="field")
    alias: StrictStr = Field(description="Name for the aggregation result in output. REQUIRED for all operations. Should be descriptive of the calculation. Used to reference results in post-filtering.")
    distinct_field: Optional[StrictStr] = Field(default=None, description="Field to count distinct values from. REQUIRED when function is COUNT_DISTINCT. NOT REQUIRED for other functions. Supports dot notation for nested fields.")
    __properties: ClassVar[List[str]] = ["function", "field", "alias", "distinct_field"]

    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 AggregationOperation 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 AggregationOperation from a dict"""
        if obj is None:
            return None

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

        _obj = cls.model_validate({
            "function": obj.get("function"),
            "field": obj.get("field"),
            "alias": obj.get("alias"),
            "distinct_field": obj.get("distinct_field")
        })
        return _obj


