Source code for openapi_client.models.datasource_details_datasource_config_pagination_config

# coding: utf-8

"""
    Amorphic Data Platform

    Amorphic Data Platform - API Definition documentation

    The version of the OpenAPI document: 0.3.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, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from typing import Optional, Set
from typing_extensions import Self



class DatasourceDetailsDatasourceConfigPaginationConfig(BaseModel):
    """
    Pagination configuration. Required properties depend on PaginationType value.
    """ # noqa: E501
    data_key: Optional[StrictStr] = Field(default=None, description="Key in response containing the data array (required for all pagination types)", alias="DataKey")
    page_param: Optional[StrictStr] = Field(default=None, description="Parameter name for page number (required for Page pagination)", alias="PageParam")
    size_param: Optional[StrictStr] = Field(default=None, description="Parameter name for page size (required for Page pagination)", alias="SizeParam")
    size_value: Optional[StrictInt] = Field(default=None, description="Page size value (required for Page pagination)", alias="SizeValue")
    limit_param: Optional[StrictStr] = Field(default=None, description="Parameter name for limit (required for Offset pagination)", alias="LimitParam")
    offset_param: Optional[StrictStr] = Field(default=None, description="Parameter name for offset (required for Offset pagination)", alias="OffsetParam")
    limit_value: Optional[StrictInt] = Field(default=None, description="Limit value (required for Offset pagination)", alias="LimitValue")
    cursor_param: Optional[StrictStr] = Field(default=None, description="Parameter name for cursor (required for Cursor pagination)", alias="CursorParam")
    cursor_path_in_response: Optional[StrictStr] = Field(default=None, description="Path to next cursor in response (required for Cursor pagination)", alias="CursorPathInResponse")
    __properties: ClassVar[List[str]] = ["DataKey", "PageParam", "SizeParam", "SizeValue", "LimitParam", "OffsetParam", "LimitValue", "CursorParam", "CursorPathInResponse"]

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

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

        _obj = cls.model_validate({
            "DataKey": obj.get("DataKey"),
            "PageParam": obj.get("PageParam"),
            "SizeParam": obj.get("SizeParam"),
            "SizeValue": obj.get("SizeValue"),
            "LimitParam": obj.get("LimitParam"),
            "OffsetParam": obj.get("OffsetParam"),
            "LimitValue": obj.get("LimitValue"),
            "CursorParam": obj.get("CursorParam"),
            "CursorPathInResponse": obj.get("CursorPathInResponse")
        })
        return _obj