visier-platform-sdk 22222222.99201.2243__py3-none-any.whl → 22222222.99201.2263__py3-none-any.whl

visier_platform_sdk/models/sql_source_execute_job_request_dto.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.2263
+    Contact: alpine@visier.com
+    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 visier_platform_sdk.models.sql_source_action_dto import SqlSourceActionDTO
+from visier_platform_sdk.models.sql_source_input_dto import SqlSourceInputDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SqlSourceExecuteJobRequestDTO(BaseModel):
+    """
+    SqlSourceExecuteJobRequestDTO
+    """ # noqa: E501
+    actions: Optional[List[SqlSourceActionDTO]] = Field(default=None, description="The actions to execute within the job, in order.")
+    tenants: Optional[List[StrictStr]] = Field(default=None, description="The tenants to schedule the job for. If not specified, schedules for the current tenant only.")
+    inputs: Optional[List[SqlSourceInputDTO]] = Field(default=None, description="The input files to make available to the job.")
+    keep_transaction_open_on_error: Optional[StrictBool] = Field(default=None, description="If `true`, keep the transaction open if an error occurs while executing the job. The default is to rollback the transaction.", alias="keepTransactionOpenOnError")
+    __properties: ClassVar[List[str]] = ["actions", "tenants", "inputs", "keepTransactionOpenOnError"]
+
+    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 SqlSourceExecuteJobRequestDTO 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 actions (list)
+        _items = []
+        if self.actions:
+            for _item_actions in self.actions:
+                if _item_actions:
+                    _items.append(_item_actions.to_dict())
+            _dict['actions'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in inputs (list)
+        _items = []
+        if self.inputs:
+            for _item_inputs in self.inputs:
+                if _item_inputs:
+                    _items.append(_item_inputs.to_dict())
+            _dict['inputs'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SqlSourceExecuteJobRequestDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "actions": [SqlSourceActionDTO.from_dict(_item) for _item in obj["actions"]] if obj.get("actions") is not None else None,
+            "tenants": obj.get("tenants"),
+            "inputs": [SqlSourceInputDTO.from_dict(_item) for _item in obj["inputs"]] if obj.get("inputs") is not None else None,
+            "keepTransactionOpenOnError": obj.get("keepTransactionOpenOnError")
+        })
+        return _obj
+
+

visier_platform_sdk/models/sql_source_execute_job_response_dto.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.2263
+    Contact: alpine@visier.com
+    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 visier_platform_sdk.models.sql_job_table_access_dto import SqlJobTableAccessDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SqlSourceExecuteJobResponseDTO(BaseModel):
+    """
+    SqlSourceExecuteJobResponseDTO
+    """ # noqa: E501
+    job_id: Optional[StrictStr] = Field(default=None, description="The job ID that was scheduled. If multiple tenants were specified, the jobs for each tenant will be scheduled  as child jobs of this parent job.", alias="jobId")
+    table_access: Optional[SqlJobTableAccessDTO] = Field(default=None, description="The read and write tables per job.", alias="tableAccess")
+    __properties: ClassVar[List[str]] = ["jobId", "tableAccess"]
+
+    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 SqlSourceExecuteJobResponseDTO 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 table_access
+        if self.table_access:
+            _dict['tableAccess'] = self.table_access.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SqlSourceExecuteJobResponseDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "jobId": obj.get("jobId"),
+            "tableAccess": SqlJobTableAccessDTO.from_dict(obj["tableAccess"]) if obj.get("tableAccess") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/sql_source_input_dto.py

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.2263
+    Contact: alpine@visier.com
+    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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.sql_source_io_format_dto import SqlSourceIoFormatDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SqlSourceInputDTO(BaseModel):
+    """
+    SqlSourceInputDTO
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="The name to give the input view in SQL.")
+    filename: Optional[StrictStr] = Field(default=None, description="The name of the input file.")
+    format: Optional[SqlSourceIoFormatDTO] = Field(default=None, description="The format and parameters to use to read the input file.")
+    tenant_code_column: Optional[StrictStr] = Field(default=None, description="The tenant code column to use when multiple tenants are specified.", alias="tenantCodeColumn")
+    prepend_admin_tenant_code: Optional[StrictBool] = Field(default=None, description="If `true`, the tenant codes in the column/filename do not include the parent tenant prefix.", alias="prependAdminTenantCode")
+    input_distribution_mode: Optional[StrictStr] = Field(default=None, description="Describes how to distribute input data among tenants. Required when multiple tenants are specified. Valid values:  - `NO_DISTRIBUTION`: Don't distribute to multiple tenants. Files must be uploaded directly to their target tenant.  - `DISTRIBUTE_FILES`: Distribute to multiple tenants based on the file path. The input filename must exist under subdirectories.  - `DISTRIBUTE_ROWS`: Distribute to multiple tenants by splitting rows to each tenant based on the tenant code column.", alias="inputDistributionMode")
+    file_container_name: Optional[StrictStr] = Field(default=None, description="Indicates if the file exists in a container and the container name.", alias="fileContainerName")
+    __properties: ClassVar[List[str]] = ["id", "filename", "format", "tenantCodeColumn", "prependAdminTenantCode", "inputDistributionMode", "fileContainerName"]
+
+    @field_validator('input_distribution_mode')
+    def input_distribution_mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['NO_DISTRIBUTION', 'DISTRIBUTE_FILES', 'DISTRIBUTE_ROWS']):
+            raise ValueError("must be one of enum values ('NO_DISTRIBUTION', 'DISTRIBUTE_FILES', 'DISTRIBUTE_ROWS')")
+        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 SqlSourceInputDTO 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 format
+        if self.format:
+            _dict['format'] = self.format.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SqlSourceInputDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "filename": obj.get("filename"),
+            "format": SqlSourceIoFormatDTO.from_dict(obj["format"]) if obj.get("format") is not None else None,
+            "tenantCodeColumn": obj.get("tenantCodeColumn"),
+            "prependAdminTenantCode": obj.get("prependAdminTenantCode"),
+            "inputDistributionMode": obj.get("inputDistributionMode"),
+            "fileContainerName": obj.get("fileContainerName")
+        })
+        return _obj
+
+

visier_platform_sdk/models/sql_source_io_format_dto.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.2263
+    Contact: alpine@visier.com
+    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 visier_platform_sdk.models.sql_source_io_format_dto_csv_format_dto import SqlSourceIoFormatDTOCsvFormatDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SqlSourceIoFormatDTO(BaseModel):
+    """
+    Input/output format configuration for a query.
+    """ # noqa: E501
+    csv: Optional[SqlSourceIoFormatDTOCsvFormatDTO] = Field(default=None, alias="CSV")
+    parquet: Optional[Dict[str, Any]] = Field(default=None, description="Options for the Parquet format.", alias="PARQUET")
+    __properties: ClassVar[List[str]] = ["CSV", "PARQUET"]
+
+    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 SqlSourceIoFormatDTO 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 csv
+        if self.csv:
+            _dict['CSV'] = self.csv.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SqlSourceIoFormatDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "CSV": SqlSourceIoFormatDTOCsvFormatDTO.from_dict(obj["CSV"]) if obj.get("CSV") is not None else None,
+            "PARQUET": obj.get("PARQUET")
+        })
+        return _obj
+
+

visier_platform_sdk/models/sql_source_io_format_dto_csv_format_dto.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.2263
+    Contact: alpine@visier.com
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SqlSourceIoFormatDTOCsvFormatDTO(BaseModel):
+    """
+    Options for the CSV format.
+    """ # noqa: E501
+    header: Optional[StrictBool] = Field(default=None, description="If `true`, the output includes a header row.")
+    __properties: ClassVar[List[str]] = ["header"]
+
+    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 SqlSourceIoFormatDTOCsvFormatDTO 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 SqlSourceIoFormatDTOCsvFormatDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "header": obj.get("header")
+        })
+        return _obj
+
+

visier_platform_sdk/models/sql_source_process_action_dto.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.2263
+    Contact: alpine@visier.com
+    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 SqlSourceProcessActionDTO(BaseModel):
+    """
+    A process action. Spawns a processing job for the specified data categories.
+    """ # noqa: E501
+    project_id: Optional[StrictStr] = Field(default=None, description="The project ID to execute the processing job for. If not specified, the current production project is used.", alias="projectId")
+    version_id: Optional[StrictStr] = Field(default=None, description="The version ID to execute the processing job for. If not specified, the latest version is used.", alias="versionId")
+    data_category_ids: Optional[List[StrictStr]] = Field(default=None, description="The data category IDs to spawn processing jobs for. If not specified, all data categories  used by tables that were locked by the transaction are processed.", alias="dataCategoryIds")
+    __properties: ClassVar[List[str]] = ["projectId", "versionId", "dataCategoryIds"]
+
+    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 SqlSourceProcessActionDTO 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 SqlSourceProcessActionDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "projectId": obj.get("projectId"),
+            "versionId": obj.get("versionId"),
+            "dataCategoryIds": obj.get("dataCategoryIds")
+        })
+        return _obj
+
+