unitycatalog-client 0.2.1__py3-none-any.whl

unitycatalog/client/models/__init__.py

@@ -0,0 +1,77 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    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
+
+
+# import models into model package
+from unitycatalog.client.models.aws_credentials import AwsCredentials
+from unitycatalog.client.models.azure_user_delegation_sas import AzureUserDelegationSAS
+from unitycatalog.client.models.catalog_info import CatalogInfo
+from unitycatalog.client.models.column_info import ColumnInfo
+from unitycatalog.client.models.column_type_name import ColumnTypeName
+from unitycatalog.client.models.create_catalog import CreateCatalog
+from unitycatalog.client.models.create_function import CreateFunction
+from unitycatalog.client.models.create_function_request import CreateFunctionRequest
+from unitycatalog.client.models.create_model_version import CreateModelVersion
+from unitycatalog.client.models.create_registered_model import CreateRegisteredModel
+from unitycatalog.client.models.create_schema import CreateSchema
+from unitycatalog.client.models.create_table import CreateTable
+from unitycatalog.client.models.create_volume_request_content import CreateVolumeRequestContent
+from unitycatalog.client.models.data_source_format import DataSourceFormat
+from unitycatalog.client.models.dependency import Dependency
+from unitycatalog.client.models.dependency_list import DependencyList
+from unitycatalog.client.models.finalize_model_version import FinalizeModelVersion
+from unitycatalog.client.models.function_dependency import FunctionDependency
+from unitycatalog.client.models.function_info import FunctionInfo
+from unitycatalog.client.models.function_parameter_info import FunctionParameterInfo
+from unitycatalog.client.models.function_parameter_infos import FunctionParameterInfos
+from unitycatalog.client.models.function_parameter_mode import FunctionParameterMode
+from unitycatalog.client.models.function_parameter_type import FunctionParameterType
+from unitycatalog.client.models.gcp_oauth_token import GcpOauthToken
+from unitycatalog.client.models.generate_temporary_model_version_credential import GenerateTemporaryModelVersionCredential
+from unitycatalog.client.models.generate_temporary_path_credential import GenerateTemporaryPathCredential
+from unitycatalog.client.models.generate_temporary_table_credential import GenerateTemporaryTableCredential
+from unitycatalog.client.models.generate_temporary_volume_credential import GenerateTemporaryVolumeCredential
+from unitycatalog.client.models.list_catalogs_response import ListCatalogsResponse
+from unitycatalog.client.models.list_functions_response import ListFunctionsResponse
+from unitycatalog.client.models.list_model_versions_response import ListModelVersionsResponse
+from unitycatalog.client.models.list_registered_models_response import ListRegisteredModelsResponse
+from unitycatalog.client.models.list_schemas_response import ListSchemasResponse
+from unitycatalog.client.models.list_tables_response import ListTablesResponse
+from unitycatalog.client.models.list_volumes_response_content import ListVolumesResponseContent
+from unitycatalog.client.models.model_version_info import ModelVersionInfo
+from unitycatalog.client.models.model_version_operation import ModelVersionOperation
+from unitycatalog.client.models.model_version_status import ModelVersionStatus
+from unitycatalog.client.models.path_operation import PathOperation
+from unitycatalog.client.models.permissions_change import PermissionsChange
+from unitycatalog.client.models.permissions_list import PermissionsList
+from unitycatalog.client.models.principal_type import PrincipalType
+from unitycatalog.client.models.privilege import Privilege
+from unitycatalog.client.models.privilege_assignment import PrivilegeAssignment
+from unitycatalog.client.models.registered_model_info import RegisteredModelInfo
+from unitycatalog.client.models.schema_info import SchemaInfo
+from unitycatalog.client.models.securable_type import SecurableType
+from unitycatalog.client.models.table_dependency import TableDependency
+from unitycatalog.client.models.table_info import TableInfo
+from unitycatalog.client.models.table_operation import TableOperation
+from unitycatalog.client.models.table_type import TableType
+from unitycatalog.client.models.temporary_credentials import TemporaryCredentials
+from unitycatalog.client.models.update_catalog import UpdateCatalog
+from unitycatalog.client.models.update_model_version import UpdateModelVersion
+from unitycatalog.client.models.update_permissions import UpdatePermissions
+from unitycatalog.client.models.update_registered_model import UpdateRegisteredModel
+from unitycatalog.client.models.update_schema import UpdateSchema
+from unitycatalog.client.models.update_volume_request_content import UpdateVolumeRequestContent
+from unitycatalog.client.models.volume_info import VolumeInfo
+from unitycatalog.client.models.volume_operation import VolumeOperation
+from unitycatalog.client.models.volume_type import VolumeType

unitycatalog/client/models/aws_credentials.py

@@ -0,0 +1,91 @@
+# 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 AwsCredentials(BaseModel):
+    """
+    AwsCredentials
+    """ # noqa: E501
+    access_key_id: Optional[StrictStr] = Field(default=None, description="The access key ID that identifies the temporary credentials.")
+    secret_access_key: Optional[StrictStr] = Field(default=None, description="The secret access key that can be used to sign AWS API requests.")
+    session_token: Optional[StrictStr] = Field(default=None, description="The token that users must pass to AWS API to use the temporary credentials.")
+    __properties: ClassVar[List[str]] = ["access_key_id", "secret_access_key", "session_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 AwsCredentials 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 AwsCredentials from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "access_key_id": obj.get("access_key_id"),
+            "secret_access_key": obj.get("secret_access_key"),
+            "session_token": obj.get("session_token")
+        })
+        return _obj
+
+

unitycatalog/client/models/azure_user_delegation_sas.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 AzureUserDelegationSAS(BaseModel):
+    """
+    AzureUserDelegationSAS
+    """ # noqa: E501
+    sas_token: Optional[StrictStr] = Field(default=None, description="Azure SAS Token")
+    __properties: ClassVar[List[str]] = ["sas_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 AzureUserDelegationSAS 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 AzureUserDelegationSAS from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sas_token": obj.get("sas_token")
+        })
+        return _obj
+
+

unitycatalog/client/models/catalog_info.py

@@ -0,0 +1,103 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class CatalogInfo(BaseModel):
+    """
+    CatalogInfo
+    """ # noqa: E501
+    name: Optional[StrictStr] = Field(default=None, description="Name of catalog.")
+    comment: Optional[StrictStr] = Field(default=None, description="User-provided free-form text description.")
+    properties: Optional[Dict[str, StrictStr]] = Field(default=None, description="A map of key-value properties attached to the securable.")
+    owner: Optional[StrictStr] = Field(default=None, description="Username of current owner of catalog.")
+    created_at: Optional[StrictInt] = Field(default=None, description="Time at which this catalog was created, in epoch milliseconds.")
+    created_by: Optional[StrictStr] = Field(default=None, description="Username of catalog creator.")
+    updated_at: Optional[StrictInt] = Field(default=None, description="Time at which this catalog was last modified, in epoch milliseconds.")
+    updated_by: Optional[StrictStr] = Field(default=None, description="Username of user who last modified catalog.")
+    id: Optional[StrictStr] = Field(default=None, description="Unique identifier for the catalog.")
+    __properties: ClassVar[List[str]] = ["name", "comment", "properties", "owner", "created_at", "created_by", "updated_at", "updated_by", "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 CatalogInfo 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 CatalogInfo 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"),
+            "comment": obj.get("comment"),
+            "properties": obj.get("properties"),
+            "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"),
+            "id": obj.get("id")
+        })
+        return _obj
+
+

unitycatalog/client/models/column_info.py

@@ -0,0 +1,108 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from unitycatalog.client.models.column_type_name import ColumnTypeName
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ColumnInfo(BaseModel):
+    """
+    ColumnInfo
+    """ # noqa: E501
+    name: Optional[StrictStr] = Field(default=None, description="Name of Column.")
+    type_text: Optional[StrictStr] = Field(default=None, description="Full data type specification as SQL/catalogString text.")
+    type_json: Optional[StrictStr] = Field(default=None, description="Full data type specification, JSON-serialized.")
+    type_name: Optional[ColumnTypeName] = None
+    type_precision: Optional[StrictInt] = Field(default=None, description="Digits of precision; required for DecimalTypes.")
+    type_scale: Optional[StrictInt] = Field(default=None, description="Digits to right of decimal; Required for DecimalTypes.")
+    type_interval_type: Optional[StrictStr] = Field(default=None, description="Format of IntervalType.")
+    position: Optional[StrictInt] = Field(default=None, description="Ordinal position of column (starting at position 0).")
+    comment: Optional[StrictStr] = Field(default=None, description="User-provided free-form text description.")
+    nullable: Optional[StrictBool] = Field(default=True, description="Whether field may be Null.")
+    partition_index: Optional[StrictInt] = Field(default=None, description="Partition index for column.")
+    __properties: ClassVar[List[str]] = ["name", "type_text", "type_json", "type_name", "type_precision", "type_scale", "type_interval_type", "position", "comment", "nullable", "partition_index"]
+
+    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 ColumnInfo 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 ColumnInfo 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"),
+            "comment": obj.get("comment"),
+            "nullable": obj.get("nullable") if obj.get("nullable") is not None else True,
+            "partition_index": obj.get("partition_index")
+        })
+        return _obj
+
+

unitycatalog/client/models/column_type_name.py

@@ -0,0 +1,56 @@
+# 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 ColumnTypeName(str, Enum):
+    """
+    Name of type (INT, STRUCT, MAP, etc.).
+    """
+
+    """
+    allowed enum values
+    """
+    BOOLEAN = 'BOOLEAN'
+    BYTE = 'BYTE'
+    SHORT = 'SHORT'
+    INT = 'INT'
+    LONG = 'LONG'
+    FLOAT = 'FLOAT'
+    DOUBLE = 'DOUBLE'
+    DATE = 'DATE'
+    TIMESTAMP = 'TIMESTAMP'
+    TIMESTAMP_NTZ = 'TIMESTAMP_NTZ'
+    STRING = 'STRING'
+    BINARY = 'BINARY'
+    DECIMAL = 'DECIMAL'
+    INTERVAL = 'INTERVAL'
+    ARRAY = 'ARRAY'
+    STRUCT = 'STRUCT'
+    MAP = 'MAP'
+    CHAR = 'CHAR'
+    NULL = 'NULL'
+    USER_DEFINED_TYPE = 'USER_DEFINED_TYPE'
+    TABLE_TYPE = 'TABLE_TYPE'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ColumnTypeName from a JSON string"""
+        return cls(json.loads(json_str))
+
+

unitycatalog/client/models/create_catalog.py

@@ -0,0 +1,91 @@
+# 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 CreateCatalog(BaseModel):
+    """
+    CreateCatalog
+    """ # noqa: E501
+    name: StrictStr = Field(description="Name of catalog.")
+    comment: Optional[StrictStr] = Field(default=None, description="User-provided free-form text description.")
+    properties: Optional[Dict[str, StrictStr]] = Field(default=None, description="A map of key-value properties attached to the securable.")
+    __properties: ClassVar[List[str]] = ["name", "comment", "properties"]
+
+    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 CreateCatalog 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 CreateCatalog 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"),
+            "comment": obj.get("comment"),
+            "properties": obj.get("properties")
+        })
+        return _obj
+
+