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

arthur_client/api_bindings/models/post_connector_spec.py

@@ -0,0 +1,104 @@
+# 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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.connector_spec_field import ConnectorSpecField
+from arthur_client.api_bindings.models.connector_type import ConnectorType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostConnectorSpec(BaseModel):
+    """
+    PostConnectorSpec
+    """ # noqa: E501
+    connector_type: ConnectorType = Field(description="Type of connector.")
+    name: StrictStr = Field(description="Name of connector.")
+    temporary: Optional[StrictBool] = Field(default=False, description="True if connector is temporary (ie for testing only), false otherwise.")
+    fields: List[ConnectorSpecField] = Field(description="List of non-sensitive and sensitive fields for the connector.")
+    data_plane_id: StrictStr = Field(description="ID of the data plane that will execute the connection. Should be formatted as a UUID.")
+    __properties: ClassVar[List[str]] = ["connector_type", "name", "temporary", "fields", "data_plane_id"]
+
+    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 PostConnectorSpec 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 fields (list)
+        _items = []
+        if self.fields:
+            for _item_fields in self.fields:
+                if _item_fields:
+                    _items.append(_item_fields.to_dict())
+            _dict['fields'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostConnectorSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "connector_type": obj.get("connector_type"),
+            "name": obj.get("name"),
+            "temporary": obj.get("temporary") if obj.get("temporary") is not None else False,
+            "fields": [ConnectorSpecField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
+            "data_plane_id": obj.get("data_plane_id")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/post_data_plane.py

@@ -0,0 +1,95 @@
+# 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.data_plane_capabilities import DataPlaneCapabilities
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostDataPlane(BaseModel):
+    """
+    PostDataPlane
+    """ # noqa: E501
+    name: StrictStr = Field(description="Name of data plane.")
+    description: StrictStr = Field(description="Description of data plane.")
+    capabilities: Optional[DataPlaneCapabilities] = Field(default=None, description="Capabilities for this data plane.")
+    __properties: ClassVar[List[str]] = ["name", "description", "capabilities"]
+
+    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 PostDataPlane 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 capabilities
+        if self.capabilities:
+            _dict['capabilities'] = self.capabilities.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostDataPlane from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "capabilities": DataPlaneCapabilities.from_dict(obj["capabilities"]) if obj.get("capabilities") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/post_data_plane_association.py

@@ -0,0 +1,89 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostDataPlaneAssociation(BaseModel):
+    """
+    PostDataPlaneAssociation
+    """ # noqa: E501
+    data_plane_id: StrictStr = Field(description="ID of the data plane.")
+    project_id: StrictStr = Field(description="ID of the project.")
+    __properties: ClassVar[List[str]] = ["data_plane_id", "project_id"]
+
+    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 PostDataPlaneAssociation 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 PostDataPlaneAssociation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "data_plane_id": obj.get("data_plane_id"),
+            "project_id": obj.get("project_id")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/post_data_retrieval_operation.py

@@ -0,0 +1,106 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.connector_pagination_options import ConnectorPaginationOptions
+from arthur_client.api_bindings.models.data_result_filter import DataResultFilter
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostDataRetrievalOperation(BaseModel):
+    """
+    PostDataRetrievalOperation
+    """ # noqa: E501
+    start_timestamp: datetime = Field(description="Start timestamp to retrieve data for.")
+    end_timestamp: datetime = Field(description="End timestamp to retrieve data for.")
+    data_retrieval_filters: Optional[List[DataResultFilter]] = Field(default=None, description="Filters to apply to retrieved data")
+    pagination_options: Optional[ConnectorPaginationOptions] = Field(default=None, description="Pagination options to apply to retrieved data")
+    __properties: ClassVar[List[str]] = ["start_timestamp", "end_timestamp", "data_retrieval_filters", "pagination_options"]
+
+    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 PostDataRetrievalOperation 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 data_retrieval_filters (list)
+        _items = []
+        if self.data_retrieval_filters:
+            for _item_data_retrieval_filters in self.data_retrieval_filters:
+                if _item_data_retrieval_filters:
+                    _items.append(_item_data_retrieval_filters.to_dict())
+            _dict['data_retrieval_filters'] = _items
+        # override the default output from pydantic by calling `to_dict()` of pagination_options
+        if self.pagination_options:
+            _dict['pagination_options'] = self.pagination_options.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostDataRetrievalOperation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "start_timestamp": obj.get("start_timestamp"),
+            "end_timestamp": obj.get("end_timestamp"),
+            "data_retrieval_filters": [DataResultFilter.from_dict(_item) for _item in obj["data_retrieval_filters"]] if obj.get("data_retrieval_filters") is not None else None,
+            "pagination_options": ConnectorPaginationOptions.from_dict(obj["pagination_options"]) if obj.get("pagination_options") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/post_dataset.py

@@ -0,0 +1,128 @@
+# 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.dataset_locator import DatasetLocator
+from arthur_client.api_bindings.models.model_problem_type import ModelProblemType
+from arthur_client.api_bindings.models.post_dataset_join_spec import PostDatasetJoinSpec
+from arthur_client.api_bindings.models.put_dataset_schema import PutDatasetSchema
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostDataset(BaseModel):
+    """
+    PostDataset
+    """ # noqa: E501
+    name: Optional[StrictStr] = None
+    dataset_locator: Optional[DatasetLocator] = None
+    dataset_schema: Optional[PutDatasetSchema] = None
+    dataset_join_spec: Optional[PostDatasetJoinSpec] = None
+    model_problem_type: ModelProblemType = Field(description="Model problem type associated with the dataset.")
+    __properties: ClassVar[List[str]] = ["name", "dataset_locator", "dataset_schema", "dataset_join_spec", "model_problem_type"]
+
+    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 PostDataset 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 dataset_locator
+        if self.dataset_locator:
+            _dict['dataset_locator'] = self.dataset_locator.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of dataset_schema
+        if self.dataset_schema:
+            _dict['dataset_schema'] = self.dataset_schema.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of dataset_join_spec
+        if self.dataset_join_spec:
+            _dict['dataset_join_spec'] = self.dataset_join_spec.to_dict()
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if dataset_locator (nullable) is None
+        # and model_fields_set contains the field
+        if self.dataset_locator is None and "dataset_locator" in self.model_fields_set:
+            _dict['dataset_locator'] = None
+
+        # set to None if dataset_schema (nullable) is None
+        # and model_fields_set contains the field
+        if self.dataset_schema is None and "dataset_schema" in self.model_fields_set:
+            _dict['dataset_schema'] = None
+
+        # set to None if dataset_join_spec (nullable) is None
+        # and model_fields_set contains the field
+        if self.dataset_join_spec is None and "dataset_join_spec" in self.model_fields_set:
+            _dict['dataset_join_spec'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostDataset from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "dataset_locator": DatasetLocator.from_dict(obj["dataset_locator"]) if obj.get("dataset_locator") is not None else None,
+            "dataset_schema": PutDatasetSchema.from_dict(obj["dataset_schema"]) if obj.get("dataset_schema") is not None else None,
+            "dataset_join_spec": PostDatasetJoinSpec.from_dict(obj["dataset_join_spec"]) if obj.get("dataset_join_spec") is not None else None,
+            "model_problem_type": obj.get("model_problem_type")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/post_dataset_join_spec.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 arthur_client.api_bindings.models.dataset_join_kind import DatasetJoinKind
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostDatasetJoinSpec(BaseModel):
+    """
+    PostDatasetJoinSpec
+    """ # noqa: E501
+    left_dataset_id: StrictStr = Field(description="ID of the first dataset.")
+    right_dataset_id: StrictStr = Field(description="ID of the second dataset.")
+    left_dataset_join_key: StrictStr = Field(description="Column ID from the left dataset to use as a join key.")
+    right_dataset_join_key: StrictStr = Field(description="Column ID from the right dataset to use as a join key.")
+    join_type: Optional[DatasetJoinKind] = Field(default=None, description="Kind of SQL join to perform")
+    __properties: ClassVar[List[str]] = ["left_dataset_id", "right_dataset_id", "left_dataset_join_key", "right_dataset_join_key", "join_type"]
+
+    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 PostDatasetJoinSpec 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 PostDatasetJoinSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "left_dataset_id": obj.get("left_dataset_id"),
+            "right_dataset_id": obj.get("right_dataset_id"),
+            "left_dataset_join_key": obj.get("left_dataset_join_key"),
+            "right_dataset_join_key": obj.get("right_dataset_join_key"),
+            "join_type": obj.get("join_type")
+        })
+        return _obj
+
+