arthur-client 1.4.0__py3-none-any.whl → 1.4.1186__py3-none-any.whl

arthur_client/api_bindings/models/post_job_spec.py

@@ -0,0 +1,194 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Optional
+from arthur_client.api_bindings.models.alert_check_job_spec import AlertCheckJobSpec
+from arthur_client.api_bindings.models.connector_check_job_spec import ConnectorCheckJobSpec
+from arthur_client.api_bindings.models.list_datasets_job_spec import ListDatasetsJobSpec
+from arthur_client.api_bindings.models.metrics_calculation_job_spec import MetricsCalculationJobSpec
+from arthur_client.api_bindings.models.schedule_jobs_job_spec import ScheduleJobsJobSpec
+from arthur_client.api_bindings.models.schema_inspection_job_spec import SchemaInspectionJobSpec
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+POSTJOBSPEC_ANY_OF_SCHEMAS = ["AlertCheckJobSpec", "ConnectorCheckJobSpec", "ListDatasetsJobSpec", "MetricsCalculationJobSpec", "ScheduleJobsJobSpec", "SchemaInspectionJobSpec"]
+
+class PostJobSpec(BaseModel):
+    """
+    Job specification for the job kind.
+    """
+
+    # data type: MetricsCalculationJobSpec
+    anyof_schema_1_validator: Optional[MetricsCalculationJobSpec] = None
+    # data type: SchemaInspectionJobSpec
+    anyof_schema_2_validator: Optional[SchemaInspectionJobSpec] = None
+    # data type: ConnectorCheckJobSpec
+    anyof_schema_3_validator: Optional[ConnectorCheckJobSpec] = None
+    # data type: ListDatasetsJobSpec
+    anyof_schema_4_validator: Optional[ListDatasetsJobSpec] = None
+    # data type: ScheduleJobsJobSpec
+    anyof_schema_5_validator: Optional[ScheduleJobsJobSpec] = None
+    # data type: AlertCheckJobSpec
+    anyof_schema_6_validator: Optional[AlertCheckJobSpec] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[AlertCheckJobSpec, ConnectorCheckJobSpec, ListDatasetsJobSpec, MetricsCalculationJobSpec, ScheduleJobsJobSpec, SchemaInspectionJobSpec]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "AlertCheckJobSpec", "ConnectorCheckJobSpec", "ListDatasetsJobSpec", "MetricsCalculationJobSpec", "ScheduleJobsJobSpec", "SchemaInspectionJobSpec" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = PostJobSpec.model_construct()
+        error_messages = []
+        # validate data type: MetricsCalculationJobSpec
+        if not isinstance(v, MetricsCalculationJobSpec):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `MetricsCalculationJobSpec`")
+        else:
+            return v
+
+        # validate data type: SchemaInspectionJobSpec
+        if not isinstance(v, SchemaInspectionJobSpec):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `SchemaInspectionJobSpec`")
+        else:
+            return v
+
+        # validate data type: ConnectorCheckJobSpec
+        if not isinstance(v, ConnectorCheckJobSpec):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ConnectorCheckJobSpec`")
+        else:
+            return v
+
+        # validate data type: ListDatasetsJobSpec
+        if not isinstance(v, ListDatasetsJobSpec):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ListDatasetsJobSpec`")
+        else:
+            return v
+
+        # validate data type: ScheduleJobsJobSpec
+        if not isinstance(v, ScheduleJobsJobSpec):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ScheduleJobsJobSpec`")
+        else:
+            return v
+
+        # validate data type: AlertCheckJobSpec
+        if not isinstance(v, AlertCheckJobSpec):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `AlertCheckJobSpec`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in PostJobSpec with anyOf schemas: AlertCheckJobSpec, ConnectorCheckJobSpec, ListDatasetsJobSpec, MetricsCalculationJobSpec, ScheduleJobsJobSpec, SchemaInspectionJobSpec. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[MetricsCalculationJobSpec] = None
+        try:
+            instance.actual_instance = MetricsCalculationJobSpec.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[SchemaInspectionJobSpec] = None
+        try:
+            instance.actual_instance = SchemaInspectionJobSpec.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[ConnectorCheckJobSpec] = None
+        try:
+            instance.actual_instance = ConnectorCheckJobSpec.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_4_validator: Optional[ListDatasetsJobSpec] = None
+        try:
+            instance.actual_instance = ListDatasetsJobSpec.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_5_validator: Optional[ScheduleJobsJobSpec] = None
+        try:
+            instance.actual_instance = ScheduleJobsJobSpec.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_6_validator: Optional[AlertCheckJobSpec] = None
+        try:
+            instance.actual_instance = AlertCheckJobSpec.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into PostJobSpec with anyOf schemas: AlertCheckJobSpec, ConnectorCheckJobSpec, ListDatasetsJobSpec, MetricsCalculationJobSpec, ScheduleJobsJobSpec, SchemaInspectionJobSpec. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], AlertCheckJobSpec, ConnectorCheckJobSpec, ListDatasetsJobSpec, MetricsCalculationJobSpec, ScheduleJobsJobSpec, SchemaInspectionJobSpec]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

arthur_client/api_bindings/models/post_link_task_request.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostLinkTaskRequest(BaseModel):
+    """
+    PostLinkTaskRequest
+    """ # noqa: E501
+    task_id: StrictStr = Field(description="The id of the Shield task to link when creating the new model.")
+    connector_id: StrictStr = Field(description="The id of the connector with the task to link. The connector must be an engine internal connector.")
+    onboarding_identifier: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["task_id", "connector_id", "onboarding_identifier"]
+
+    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 PostLinkTaskRequest 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,
+        )
+        # set to None if onboarding_identifier (nullable) is None
+        # and model_fields_set contains the field
+        if self.onboarding_identifier is None and "onboarding_identifier" in self.model_fields_set:
+            _dict['onboarding_identifier'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostLinkTaskRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "task_id": obj.get("task_id"),
+            "connector_id": obj.get("connector_id"),
+            "onboarding_identifier": obj.get("onboarding_identifier")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/post_metrics_query.py

@@ -0,0 +1,117 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.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 arthur_client.api_bindings.models.alert_rule_interval import AlertRuleInterval
+from arthur_client.api_bindings.models.post_metrics_query_time_range import PostMetricsQueryTimeRange
+from arthur_client.api_bindings.models.result_filter import ResultFilter
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostMetricsQuery(BaseModel):
+    """
+    PostMetricsQuery
+    """ # noqa: E501
+    query: StrictStr = Field(description="Query for retrieving the metrics.")
+    time_range: PostMetricsQueryTimeRange = Field(description="Time range to filter the metrics by.")
+    interval: Optional[AlertRuleInterval] = None
+    limit: Optional[StrictInt] = Field(default=50, description="Limit the number of metrics returned. Defaults to 50.")
+    result_filter: Optional[ResultFilter] = None
+    __properties: ClassVar[List[str]] = ["query", "time_range", "interval", "limit", "result_filter"]
+
+    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 PostMetricsQuery 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of time_range
+        if self.time_range:
+            _dict['time_range'] = self.time_range.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of interval
+        if self.interval:
+            _dict['interval'] = self.interval.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of result_filter
+        if self.result_filter:
+            _dict['result_filter'] = self.result_filter.to_dict()
+        # set to None if interval (nullable) is None
+        # and model_fields_set contains the field
+        if self.interval is None and "interval" in self.model_fields_set:
+            _dict['interval'] = None
+
+        # set to None if result_filter (nullable) is None
+        # and model_fields_set contains the field
+        if self.result_filter is None and "result_filter" in self.model_fields_set:
+            _dict['result_filter'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostMetricsQuery from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "query": obj.get("query"),
+            "time_range": PostMetricsQueryTimeRange.from_dict(obj["time_range"]) if obj.get("time_range") is not None else None,
+            "interval": AlertRuleInterval.from_dict(obj["interval"]) if obj.get("interval") is not None else None,
+            "limit": obj.get("limit") if obj.get("limit") is not None else 50,
+            "result_filter": ResultFilter.from_dict(obj["result_filter"]) if obj.get("result_filter") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/post_metrics_query_result_filter.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.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, Optional
+from arthur_client.api_bindings.models.metrics_result_filter_op import MetricsResultFilterOp
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostMetricsQueryResultFilter(BaseModel):
+    """
+    PostMetricsQueryResultFilter
+    """ # noqa: E501
+    column: StrictStr = Field(description="Column name to use for filtering metrics.")
+    op: MetricsResultFilterOp = Field(description="Operation to filter metrics. One of 'greater_than', 'less_than', 'equals', 'not_equals', 'greater_than_or_equal', 'less_than_or_equal', 'in', 'not_in'.")
+    value: Optional[Any]
+    __properties: ClassVar[List[str]] = ["column", "op", "value"]
+
+    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 PostMetricsQueryResultFilter 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,
+        )
+        # set to None if value (nullable) is None
+        # and model_fields_set contains the field
+        if self.value is None and "value" in self.model_fields_set:
+            _dict['value'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostMetricsQueryResultFilter from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "column": obj.get("column"),
+            "op": obj.get("op"),
+            "value": obj.get("value")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/post_metrics_query_result_filter_and_group.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostMetricsQueryResultFilterAndGroup(BaseModel):
+    """
+    PostMetricsQueryResultFilterAndGroup
+    """ # noqa: E501
+    var_and: List[PostMetricsQueryResultFilterAndGroupAndInner] = Field(description="List of filters to apply with AND operator. Needs to be provided if `or` is empty.", alias="and")
+    __properties: ClassVar[List[str]] = ["and"]
+
+    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 PostMetricsQueryResultFilterAndGroup 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in var_and (list)
+        _items = []
+        if self.var_and:
+            for _item_var_and in self.var_and:
+                if _item_var_and:
+                    _items.append(_item_var_and.to_dict())
+            _dict['and'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostMetricsQueryResultFilterAndGroup from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "and": [PostMetricsQueryResultFilterAndGroupAndInner.from_dict(_item) for _item in obj["and"]] if obj.get("and") is not None else None
+        })
+        return _obj
+
+from arthur_client.api_bindings.models.post_metrics_query_result_filter_and_group_and_inner import PostMetricsQueryResultFilterAndGroupAndInner
+# TODO: Rewrite to not use raise_errors
+PostMetricsQueryResultFilterAndGroup.model_rebuild(raise_errors=False)
+