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

arthur_client/api_bindings/models/connector_spec_field_with_metadata.py

@@ -0,0 +1,94 @@
+# 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
+from arthur_client.api_bindings.models.connector_field_data_type import ConnectorFieldDataType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConnectorSpecFieldWithMetadata(BaseModel):
+    """
+    ConnectorSpecFieldWithMetadata
+    """ # noqa: E501
+    key: StrictStr = Field(description="Name of connector field.")
+    value: StrictStr = Field(description="Value of connector field.")
+    d_type: ConnectorFieldDataType = Field(description="Data type of connector field.")
+    is_sensitive: StrictBool = Field(description="Whether or not this is a sensitive field.")
+    __properties: ClassVar[List[str]] = ["key", "value", "d_type", "is_sensitive"]
+
+    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 ConnectorSpecFieldWithMetadata 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 ConnectorSpecFieldWithMetadata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "key": obj.get("key"),
+            "value": obj.get("value"),
+            "d_type": obj.get("d_type"),
+            "is_sensitive": obj.get("is_sensitive")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/connector_spec_schema.py

@@ -0,0 +1,111 @@
+# 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, StrictBool
+from typing import Any, ClassVar, Dict, List
+from arthur_client.api_bindings.models.connector_spec_schema_field import ConnectorSpecSchemaField
+from arthur_client.api_bindings.models.connector_type import ConnectorType
+from arthur_client.api_bindings.models.dataset_locator_schema import DatasetLocatorSchema
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConnectorSpecSchema(BaseModel):
+    """
+    ConnectorSpecSchema
+    """ # noqa: E501
+    created_at: datetime = Field(description="Time of record creation.")
+    updated_at: datetime = Field(description="Time of last record update.")
+    connector_type: ConnectorType = Field(description="Connector type for the schema. Must be unique.")
+    fields: List[ConnectorSpecSchemaField] = Field(description="Metadata for optional and required connector fields.")
+    dataset_locator_schema: DatasetLocatorSchema = Field(description="Schema with dataset locator metadata for all datasets using the connector type.")
+    supports_dataset_listing: StrictBool = Field(description="Indicates whether this connector supports listing available datasets.")
+    __properties: ClassVar[List[str]] = ["created_at", "updated_at", "connector_type", "fields", "dataset_locator_schema", "supports_dataset_listing"]
+
+    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 ConnectorSpecSchema 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
+        # override the default output from pydantic by calling `to_dict()` of dataset_locator_schema
+        if self.dataset_locator_schema:
+            _dict['dataset_locator_schema'] = self.dataset_locator_schema.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConnectorSpecSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "connector_type": obj.get("connector_type"),
+            "fields": [ConnectorSpecSchemaField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
+            "dataset_locator_schema": DatasetLocatorSchema.from_dict(obj["dataset_locator_schema"]) if obj.get("dataset_locator_schema") is not None else None,
+            "supports_dataset_listing": obj.get("supports_dataset_listing")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/connector_spec_schema_field.py

@@ -0,0 +1,103 @@
+# 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_field_data_type import ConnectorFieldDataType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConnectorSpecSchemaField(BaseModel):
+    """
+    ConnectorSpecSchemaField
+    """ # noqa: E501
+    name: StrictStr = Field(description="Name of connector field.")
+    is_sensitive: StrictBool = Field(description="If field stores sensitive data.")
+    is_optional: StrictBool = Field(description="If field is optional or required.")
+    d_type: ConnectorFieldDataType = Field(description="Data type of the value stored by the field.")
+    description: StrictStr = Field(description="Description of connector field.")
+    allowed_values: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["name", "is_sensitive", "is_optional", "d_type", "description", "allowed_values"]
+
+    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 ConnectorSpecSchemaField 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 allowed_values (nullable) is None
+        # and model_fields_set contains the field
+        if self.allowed_values is None and "allowed_values" in self.model_fields_set:
+            _dict['allowed_values'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConnectorSpecSchemaField 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"),
+            "is_sensitive": obj.get("is_sensitive"),
+            "is_optional": obj.get("is_optional"),
+            "d_type": obj.get("d_type"),
+            "description": obj.get("description"),
+            "allowed_values": obj.get("allowed_values")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/connector_type.py

@@ -0,0 +1,40 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class ConnectorType(str, Enum):
+    """
+    ConnectorType
+    """
+
+    """
+    allowed enum values
+    """
+    SHIELD = 'shield'
+    S3 = 'S3'
+    GCS = 'GCS'
+    BIGQUERY = 'BigQuery'
+    ENGINE_INTERNAL = 'engine_internal'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ConnectorType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/connectors_sort.py

@@ -0,0 +1,38 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class ConnectorsSort(str, Enum):
+    """
+    ConnectorsSort
+    """
+
+    """
+    allowed enum values
+    """
+    CREATED_AT = 'created_at'
+    UPDATED_AT = 'updated_at'
+    NAME = 'name'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ConnectorsSort from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/create_model_link_task_job_spec.py

@@ -0,0 +1,108 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateModelLinkTaskJobSpec(BaseModel):
+    """
+    CreateModelLinkTaskJobSpec
+    """ # noqa: E501
+    job_type: Optional[StrictStr] = 'link_model_task'
+    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 engine internal connector to use to link the task.")
+    onboarding_identifier: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["job_type", "task_id", "connector_id", "onboarding_identifier"]
+
+    @field_validator('job_type')
+    def job_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['link_model_task']):
+            raise ValueError("must be one of enum values ('link_model_task')")
+        return 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 CreateModelLinkTaskJobSpec 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 CreateModelLinkTaskJobSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job_type": obj.get("job_type") if obj.get("job_type") is not None else 'link_model_task',
+            "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/create_model_task_job_spec.py

@@ -0,0 +1,118 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.new_rule_request import NewRuleRequest
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateModelTaskJobSpec(BaseModel):
+    """
+    CreateModelTaskJobSpec
+    """ # noqa: E501
+    job_type: Optional[StrictStr] = 'create_model_task'
+    connector_id: StrictStr = Field(description="The id of the engine internal connector to use to create the task.")
+    task_name: StrictStr = Field(description="The name of the task.")
+    onboarding_identifier: Optional[StrictStr] = None
+    initial_rules: List[NewRuleRequest] = Field(description="The initial rules to apply to the created model.")
+    __properties: ClassVar[List[str]] = ["job_type", "connector_id", "task_name", "onboarding_identifier", "initial_rules"]
+
+    @field_validator('job_type')
+    def job_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['create_model_task']):
+            raise ValueError("must be one of enum values ('create_model_task')")
+        return 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 CreateModelTaskJobSpec 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 initial_rules (list)
+        _items = []
+        if self.initial_rules:
+            for _item_initial_rules in self.initial_rules:
+                if _item_initial_rules:
+                    _items.append(_item_initial_rules.to_dict())
+            _dict['initial_rules'] = _items
+        # 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 CreateModelTaskJobSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job_type": obj.get("job_type") if obj.get("job_type") is not None else 'create_model_task',
+            "connector_id": obj.get("connector_id"),
+            "task_name": obj.get("task_name"),
+            "onboarding_identifier": obj.get("onboarding_identifier"),
+            "initial_rules": [NewRuleRequest.from_dict(_item) for _item in obj["initial_rules"]] if obj.get("initial_rules") is not None else None
+        })
+        return _obj
+
+