unitycatalog-client 0.2.1__py3-none-any.whl

unitycatalog/client/models/function_info.py

@@ -0,0 +1,189 @@
+# coding: utf-8
+
+"""
+    Unity Catalog API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1
+    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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from unitycatalog.client.models.column_type_name import ColumnTypeName
+from unitycatalog.client.models.dependency_list import DependencyList
+from unitycatalog.client.models.function_parameter_infos import FunctionParameterInfos
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionInfo(BaseModel):
+    """
+    FunctionInfo
+    """ # noqa: E501
+    name: Optional[StrictStr] = Field(default=None, description="Name of function, relative to parent schema.")
+    catalog_name: Optional[StrictStr] = Field(default=None, description="Name of parent catalog.")
+    schema_name: Optional[StrictStr] = Field(default=None, description="Name of parent schema relative to its parent catalog.")
+    input_params: Optional[FunctionParameterInfos] = None
+    data_type: Optional[ColumnTypeName] = None
+    full_data_type: Optional[StrictStr] = Field(default=None, description="Pretty printed function data type.")
+    return_params: Optional[FunctionParameterInfos] = None
+    routine_body: Optional[StrictStr] = Field(default=None, description="Function language. When **EXTERNAL** is used, the language of the routine function should be specified in the __external_language__ field,  and the __return_params__ of the function cannot be used (as **TABLE** return type is not supported), and the __sql_data_access__ field must be **NO_SQL**. ")
+    routine_definition: Optional[StrictStr] = Field(default=None, description="Function body.")
+    routine_dependencies: Optional[DependencyList] = None
+    parameter_style: Optional[StrictStr] = Field(default=None, description="Function parameter style. **S** is the value for SQL.")
+    is_deterministic: Optional[StrictBool] = Field(default=None, description="Whether the function is deterministic.")
+    sql_data_access: Optional[StrictStr] = Field(default=None, description="Function SQL data access.")
+    is_null_call: Optional[StrictBool] = Field(default=None, description="Function null call.")
+    security_type: Optional[StrictStr] = Field(default=None, description="Function security type.")
+    specific_name: Optional[StrictStr] = Field(default=None, description="Specific name of the function; Reserved for future use.")
+    comment: Optional[StrictStr] = Field(default=None, description="User-provided free-form text description.")
+    properties: Optional[StrictStr] = Field(default=None, description="JSON-serialized key-value pair map, encoded (escaped) as a string.")
+    full_name: Optional[StrictStr] = Field(default=None, description="Full name of function, in form of __catalog_name__.__schema_name__.__function__name__")
+    owner: Optional[StrictStr] = Field(default=None, description="Username of current owner of function.")
+    created_at: Optional[StrictInt] = Field(default=None, description="Time at which this function was created, in epoch milliseconds.")
+    created_by: Optional[StrictStr] = Field(default=None, description="Username of function creator.")
+    updated_at: Optional[StrictInt] = Field(default=None, description="Time at which this function was last updated, in epoch milliseconds.")
+    updated_by: Optional[StrictStr] = Field(default=None, description="Username of user who last modified function.")
+    function_id: Optional[StrictStr] = Field(default=None, description="Id of Function, relative to parent schema.")
+    external_language: Optional[StrictStr] = Field(default=None, description="External language of the function.")
+    __properties: ClassVar[List[str]] = ["name", "catalog_name", "schema_name", "input_params", "data_type", "full_data_type", "return_params", "routine_body", "routine_definition", "routine_dependencies", "parameter_style", "is_deterministic", "sql_data_access", "is_null_call", "security_type", "specific_name", "comment", "properties", "full_name", "owner", "created_at", "created_by", "updated_at", "updated_by", "function_id", "external_language"]
+
+    @field_validator('routine_body')
+    def routine_body_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['SQL', 'EXTERNAL']):
+            raise ValueError("must be one of enum values ('SQL', 'EXTERNAL')")
+        return value
+
+    @field_validator('parameter_style')
+    def parameter_style_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['S']):
+            raise ValueError("must be one of enum values ('S')")
+        return value
+
+    @field_validator('sql_data_access')
+    def sql_data_access_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['CONTAINS_SQL', 'READS_SQL_DATA', 'NO_SQL']):
+            raise ValueError("must be one of enum values ('CONTAINS_SQL', 'READS_SQL_DATA', 'NO_SQL')")
+        return value
+
+    @field_validator('security_type')
+    def security_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['DEFINER']):
+            raise ValueError("must be one of enum values ('DEFINER')")
+        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 FunctionInfo 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 input_params
+        if self.input_params:
+            _dict['input_params'] = self.input_params.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of return_params
+        if self.return_params:
+            _dict['return_params'] = self.return_params.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of routine_dependencies
+        if self.routine_dependencies:
+            _dict['routine_dependencies'] = self.routine_dependencies.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionInfo 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"),
+            "catalog_name": obj.get("catalog_name"),
+            "schema_name": obj.get("schema_name"),
+            "input_params": FunctionParameterInfos.from_dict(obj["input_params"]) if obj.get("input_params") is not None else None,
+            "data_type": obj.get("data_type"),
+            "full_data_type": obj.get("full_data_type"),
+            "return_params": FunctionParameterInfos.from_dict(obj["return_params"]) if obj.get("return_params") is not None else None,
+            "routine_body": obj.get("routine_body"),
+            "routine_definition": obj.get("routine_definition"),
+            "routine_dependencies": DependencyList.from_dict(obj["routine_dependencies"]) if obj.get("routine_dependencies") is not None else None,
+            "parameter_style": obj.get("parameter_style"),
+            "is_deterministic": obj.get("is_deterministic"),
+            "sql_data_access": obj.get("sql_data_access"),
+            "is_null_call": obj.get("is_null_call"),
+            "security_type": obj.get("security_type"),
+            "specific_name": obj.get("specific_name"),
+            "comment": obj.get("comment"),
+            "properties": obj.get("properties"),
+            "full_name": obj.get("full_name"),
+            "owner": obj.get("owner"),
+            "created_at": obj.get("created_at"),
+            "created_by": obj.get("created_by"),
+            "updated_at": obj.get("updated_at"),
+            "updated_by": obj.get("updated_by"),
+            "function_id": obj.get("function_id"),
+            "external_language": obj.get("external_language")
+        })
+        return _obj
+
+

unitycatalog/client/models/function_parameter_info.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    Unity Catalog API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1
+    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 unitycatalog.client.models.column_type_name import ColumnTypeName
+from unitycatalog.client.models.function_parameter_mode import FunctionParameterMode
+from unitycatalog.client.models.function_parameter_type import FunctionParameterType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionParameterInfo(BaseModel):
+    """
+    FunctionParameterInfo
+    """ # noqa: E501
+    name: StrictStr = Field(description="Name of parameter.")
+    type_text: StrictStr = Field(description="Full data type spec, SQL/catalogString text.")
+    type_json: StrictStr = Field(description="Full data type spec, JSON-serialized.")
+    type_name: ColumnTypeName
+    type_precision: Optional[StrictInt] = Field(default=None, description="Digits of precision; required on Create for DecimalTypes.")
+    type_scale: Optional[StrictInt] = Field(default=None, description="Digits to right of decimal; Required on Create for DecimalTypes.")
+    type_interval_type: Optional[StrictStr] = Field(default=None, description="Format of IntervalType.")
+    position: StrictInt = Field(description="Ordinal position of column (starting at position 0).")
+    parameter_mode: Optional[FunctionParameterMode] = None
+    parameter_type: Optional[FunctionParameterType] = None
+    parameter_default: Optional[StrictStr] = Field(default=None, description="Default value of the parameter.")
+    comment: Optional[StrictStr] = Field(default=None, description="User-provided free-form text description.")
+    __properties: ClassVar[List[str]] = ["name", "type_text", "type_json", "type_name", "type_precision", "type_scale", "type_interval_type", "position", "parameter_mode", "parameter_type", "parameter_default", "comment"]
+
+    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 FunctionParameterInfo 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 FunctionParameterInfo 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"),
+            "type_text": obj.get("type_text"),
+            "type_json": obj.get("type_json"),
+            "type_name": obj.get("type_name"),
+            "type_precision": obj.get("type_precision"),
+            "type_scale": obj.get("type_scale"),
+            "type_interval_type": obj.get("type_interval_type"),
+            "position": obj.get("position"),
+            "parameter_mode": obj.get("parameter_mode"),
+            "parameter_type": obj.get("parameter_type"),
+            "parameter_default": obj.get("parameter_default"),
+            "comment": obj.get("comment")
+        })
+        return _obj
+
+

unitycatalog/client/models/function_parameter_infos.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    Unity Catalog API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1
+    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, Optional
+from unitycatalog.client.models.function_parameter_info import FunctionParameterInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionParameterInfos(BaseModel):
+    """
+    FunctionParameterInfos
+    """ # noqa: E501
+    parameters: Optional[List[FunctionParameterInfo]] = Field(default=None, description="The array of __FunctionParameterInfo__ definitions of the function's parameters.")
+    __properties: ClassVar[List[str]] = ["parameters"]
+
+    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 FunctionParameterInfos 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 parameters (list)
+        _items = []
+        if self.parameters:
+            for _item in self.parameters:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['parameters'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionParameterInfos from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameters": [FunctionParameterInfo.from_dict(_item) for _item in obj["parameters"]] if obj.get("parameters") is not None else None
+        })
+        return _obj
+
+

unitycatalog/client/models/function_parameter_mode.py

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+"""
+    Unity Catalog API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1
+    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 FunctionParameterMode(str, Enum):
+    """
+    The mode of the function parameter.
+    """
+
+    """
+    allowed enum values
+    """
+    IN = 'IN'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FunctionParameterMode from a JSON string"""
+        return cls(json.loads(json_str))
+
+

unitycatalog/client/models/function_parameter_type.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+    Unity Catalog API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1
+    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 FunctionParameterType(str, Enum):
+    """
+    The type of function parameter.
+    """
+
+    """
+    allowed enum values
+    """
+    PARAM = 'PARAM'
+    COLUMN = 'COLUMN'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FunctionParameterType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

unitycatalog/client/models/gcp_oauth_token.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    Unity Catalog API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1
+    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 GcpOauthToken(BaseModel):
+    """
+    GcpOauthToken
+    """ # noqa: E501
+    oauth_token: Optional[StrictStr] = Field(default=None, description="Gcp Token")
+    __properties: ClassVar[List[str]] = ["oauth_token"]
+
+    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 GcpOauthToken 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 GcpOauthToken from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "oauth_token": obj.get("oauth_token")
+        })
+        return _obj
+
+

unitycatalog/client/models/generate_temporary_model_version_credential.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    Unity Catalog API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1
+    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
+from unitycatalog.client.models.model_version_operation import ModelVersionOperation
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GenerateTemporaryModelVersionCredential(BaseModel):
+    """
+    GenerateTemporaryModelVersionCredential
+    """ # noqa: E501
+    catalog_name: StrictStr = Field(description="Catalog name for which temporary credentials are generated.  Can be obtained from models/{full_name} (get model info) API. ")
+    schema_name: StrictStr = Field(description="Schema name for which temporary credentials are generated.  Can be obtained from models/{full_name} (get model info) API. ")
+    model_name: StrictStr = Field(description="Model name for which temporary credentials are generated.  Can be obtained from models/{full_name} (get model info) API. ")
+    version: StrictInt = Field(description="Model version for which temporary credentials are generated. ")
+    operation: ModelVersionOperation
+    __properties: ClassVar[List[str]] = ["catalog_name", "schema_name", "model_name", "version", "operation"]
+
+    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 GenerateTemporaryModelVersionCredential 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 GenerateTemporaryModelVersionCredential from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "catalog_name": obj.get("catalog_name"),
+            "schema_name": obj.get("schema_name"),
+            "model_name": obj.get("model_name"),
+            "version": obj.get("version"),
+            "operation": obj.get("operation")
+        })
+        return _obj
+
+