stackit-intake 0.1.0__py3-none-any.whl

stackit/intake/models/intake_catalog.py

@@ -0,0 +1,118 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.2.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Annotated, Self
+
+from stackit.intake.models.catalog_auth import CatalogAuth
+
+
+class IntakeCatalog(BaseModel):
+    """
+    The Iceberg catalog configuration
+    """  # noqa: E501
+
+    auth: Optional[CatalogAuth] = None
+    namespace: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
+        default="intake",
+        description="The namespace to which data shall be written. It will be automatically created, if it does not exist.",
+    )
+    partition_by: Optional[List[Annotated[str, Field(strict=True, max_length=1024)]]] = Field(
+        default=None, alias="partitionBy"
+    )
+    table_name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=32)]] = Field(
+        default=None,
+        description="The table name is a short name chosen by the user to identify the table in Iceberg.",
+        alias="tableName",
+    )
+    uri: Annotated[str, Field(strict=True, max_length=1024)] = Field(
+        description="The URI to the Iceberg catalog endpoint"
+    )
+    warehouse: Annotated[str, Field(strict=True, max_length=1024)] = Field(
+        description="The Iceberg warehouse to connect to, required when the catalog has no default warehouse configured."
+    )
+    __properties: ClassVar[List[str]] = ["auth", "namespace", "partitionBy", "tableName", "uri", "warehouse"]
+
+    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 IntakeCatalog 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 auth
+        if self.auth:
+            _dict["auth"] = self.auth.to_dict()
+        # set to None if partition_by (nullable) is None
+        # and model_fields_set contains the field
+        if self.partition_by is None and "partition_by" in self.model_fields_set:
+            _dict["partitionBy"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IntakeCatalog from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "auth": CatalogAuth.from_dict(obj["auth"]) if obj.get("auth") is not None else None,
+                "namespace": obj.get("namespace") if obj.get("namespace") is not None else "intake",
+                "partitionBy": obj.get("partitionBy"),
+                "tableName": obj.get("tableName"),
+                "uri": obj.get("uri"),
+                "warehouse": obj.get("warehouse"),
+            }
+        )
+        return _obj

stackit/intake/models/intake_catalog_patch.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.2.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Annotated, Self
+
+from stackit.intake.models.catalog_auth_patch import CatalogAuthPatch
+
+
+class IntakeCatalogPatch(BaseModel):
+    """
+    The Iceberg catalog configuration
+    """  # noqa: E501
+
+    auth: Optional[CatalogAuthPatch] = None
+    namespace: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
+        default="intake",
+        description="The namespace to which data shall be written. It will be automatically created, if it does not exist.",
+    )
+    table_name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=32)]] = Field(
+        default=None,
+        description="The table name is a short name chosen by the user to identify the table in Iceberg.",
+        alias="tableName",
+    )
+    uri: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
+        default=None, description="The URI to the Iceberg catalog endpoint"
+    )
+    warehouse: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
+        default=None,
+        description="The Iceberg warehouse to connect to, required when the catalog has no default warehouse configured.",
+    )
+    __properties: ClassVar[List[str]] = ["auth", "namespace", "tableName", "uri", "warehouse"]
+
+    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 IntakeCatalogPatch 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 auth
+        if self.auth:
+            _dict["auth"] = self.auth.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IntakeCatalogPatch from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "auth": CatalogAuthPatch.from_dict(obj["auth"]) if obj.get("auth") is not None else None,
+                "namespace": obj.get("namespace") if obj.get("namespace") is not None else "intake",
+                "tableName": obj.get("tableName"),
+                "uri": obj.get("uri"),
+                "warehouse": obj.get("warehouse"),
+            }
+        )
+        return _obj

stackit/intake/models/intake_response.py

@@ -0,0 +1,158 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.2.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+from stackit.intake.models.intake_catalog import IntakeCatalog
+
+
+class IntakeResponse(BaseModel):
+    """
+    IntakeResponse
+    """  # noqa: E501
+
+    catalog: IntakeCatalog
+    create_time: datetime = Field(description="The point in time the resource was created.")
+    dead_letter_topic: Annotated[str, Field(strict=True, max_length=1024)] = Field(
+        description="The topic where undelivered messages are published (Dead Letter Queue).", alias="deadLetterTopic"
+    )
+    description: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
+        default=None,
+        description="The description is a longer text chosen by the user to provide more context for the resource.",
+    )
+    display_name: Annotated[str, Field(min_length=1, strict=True, max_length=32)] = Field(
+        description="The display name is a short name chosen by the user to identify the resource.", alias="displayName"
+    )
+    failure_message: Optional[StrictStr] = Field(
+        default=None, description="A human-readable description of the error, if the state is 'failed'."
+    )
+    id: StrictStr = Field(description="A auto generated unique id which identifies the resource.")
+    intake_runner_id: StrictStr = Field(
+        description="The unique id of the intake runner this intake is running on.", alias="intakeRunnerId"
+    )
+    labels: Optional[Dict[str, StrictStr]] = Field(
+        default=None, description="Labels are a set of key-value pairs assigned to resources."
+    )
+    state: StrictStr = Field(description="The current state of the resource.")
+    topic: Annotated[str, Field(strict=True, max_length=1024)] = Field(description="The topic to publish data to.")
+    undelivered_message_count: Optional[StrictInt] = Field(
+        default=None,
+        description="Number of messages that failed delivery and were sent to the Dead Letter Queue.",
+        alias="undeliveredMessageCount",
+    )
+    uri: Annotated[str, Field(strict=True, max_length=1024)] = Field(description="The URI for reaching the resource.")
+    __properties: ClassVar[List[str]] = [
+        "catalog",
+        "create_time",
+        "deadLetterTopic",
+        "description",
+        "displayName",
+        "failure_message",
+        "id",
+        "intakeRunnerId",
+        "labels",
+        "state",
+        "topic",
+        "undeliveredMessageCount",
+        "uri",
+    ]
+
+    @field_validator("state")
+    def state_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["reconciling", "active", "deleting", "failed"]):
+            raise ValueError("must be one of enum values ('reconciling', 'active', 'deleting', 'failed')")
+        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 IntakeResponse 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 catalog
+        if self.catalog:
+            _dict["catalog"] = self.catalog.to_dict()
+        # set to None if labels (nullable) is None
+        # and model_fields_set contains the field
+        if self.labels is None and "labels" in self.model_fields_set:
+            _dict["labels"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IntakeResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "catalog": IntakeCatalog.from_dict(obj["catalog"]) if obj.get("catalog") is not None else None,
+                "create_time": obj.get("create_time"),
+                "deadLetterTopic": obj.get("deadLetterTopic"),
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "failure_message": obj.get("failure_message"),
+                "id": obj.get("id"),
+                "intakeRunnerId": obj.get("intakeRunnerId"),
+                "labels": obj.get("labels"),
+                "state": obj.get("state"),
+                "topic": obj.get("topic"),
+                "undeliveredMessageCount": obj.get("undeliveredMessageCount"),
+                "uri": obj.get("uri"),
+            }
+        )
+        return _obj

stackit/intake/models/intake_runner_response.py

@@ -0,0 +1,135 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.2.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+
+class IntakeRunnerResponse(BaseModel):
+    """
+    IntakeRunnerResponse
+    """  # noqa: E501
+
+    create_time: datetime = Field(description="The point in time the resource was created.")
+    description: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
+        default=None,
+        description="The description is a longer text chosen by the user to provide more context for the resource.",
+    )
+    display_name: Annotated[str, Field(min_length=1, strict=True, max_length=32)] = Field(
+        description="The display name is a short name chosen by the user to identify the resource.", alias="displayName"
+    )
+    id: StrictStr = Field(description="A auto generated unique id which identifies the resource.")
+    labels: Optional[Dict[str, StrictStr]] = Field(
+        default=None, description="Labels are a set of key-value pairs assigned to resources."
+    )
+    max_message_size_ki_b: StrictInt = Field(
+        description="The maximum size of a message in kibibytes (1 KiB = 1024 bytes).", alias="maxMessageSizeKiB"
+    )
+    max_messages_per_hour: StrictInt = Field(
+        description="The maximum number of messages per hour.", alias="maxMessagesPerHour"
+    )
+    state: StrictStr = Field(description="The current state of the resource.")
+    uri: Annotated[str, Field(strict=True, max_length=1024)] = Field(description="The URI for reaching the resource.")
+    __properties: ClassVar[List[str]] = [
+        "create_time",
+        "description",
+        "displayName",
+        "id",
+        "labels",
+        "maxMessageSizeKiB",
+        "maxMessagesPerHour",
+        "state",
+        "uri",
+    ]
+
+    @field_validator("state")
+    def state_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["reconciling", "active", "deleting"]):
+            raise ValueError("must be one of enum values ('reconciling', 'active', 'deleting')")
+        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 IntakeRunnerResponse 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 labels (nullable) is None
+        # and model_fields_set contains the field
+        if self.labels is None and "labels" in self.model_fields_set:
+            _dict["labels"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IntakeRunnerResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "create_time": obj.get("create_time"),
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "id": obj.get("id"),
+                "labels": obj.get("labels"),
+                "maxMessageSizeKiB": obj.get("maxMessageSizeKiB"),
+                "maxMessagesPerHour": obj.get("maxMessagesPerHour"),
+                "state": obj.get("state"),
+                "uri": obj.get("uri"),
+            }
+        )
+        return _obj

stackit/intake/models/intake_user_response.py

@@ -0,0 +1,139 @@
+# coding: utf-8
+
+"""
+    STACKIT Intake API
+
+    This API provides endpoints for managing Intakes. 
+
+    The version of the OpenAPI document: 1beta.2.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+from stackit.intake.models.client_config import ClientConfig
+from stackit.intake.models.user_type import UserType
+
+
+class IntakeUserResponse(BaseModel):
+    """
+    IntakeUserResponse
+    """  # noqa: E501
+
+    client_config: Optional[ClientConfig] = Field(default=None, alias="clientConfig")
+    create_time: datetime = Field(description="The point in time the resource was created.")
+    description: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
+        default=None,
+        description="The description is a longer text chosen by the user to provide more context for the resource.",
+    )
+    display_name: Annotated[str, Field(min_length=1, strict=True, max_length=32)] = Field(
+        description="The display name is a short name chosen by the user to identify the resource.", alias="displayName"
+    )
+    id: StrictStr = Field(description="A auto generated unique id which identifies the resource.")
+    labels: Optional[Dict[str, StrictStr]] = Field(
+        default=None, description="Labels are a set of key-value pairs assigned to resources."
+    )
+    state: StrictStr = Field(description="The current state of the resource.")
+    type: UserType
+    user: Annotated[str, Field(strict=True, max_length=1024)] = Field(description="The user to connect to the intake.")
+    __properties: ClassVar[List[str]] = [
+        "clientConfig",
+        "create_time",
+        "description",
+        "displayName",
+        "id",
+        "labels",
+        "state",
+        "type",
+        "user",
+    ]
+
+    @field_validator("state")
+    def state_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["reconciling", "active", "deleting"]):
+            raise ValueError("must be one of enum values ('reconciling', 'active', 'deleting')")
+        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 IntakeUserResponse 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 client_config
+        if self.client_config:
+            _dict["clientConfig"] = self.client_config.to_dict()
+        # set to None if labels (nullable) is None
+        # and model_fields_set contains the field
+        if self.labels is None and "labels" in self.model_fields_set:
+            _dict["labels"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IntakeUserResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "clientConfig": (
+                    ClientConfig.from_dict(obj["clientConfig"]) if obj.get("clientConfig") is not None else None
+                ),
+                "create_time": obj.get("create_time"),
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "id": obj.get("id"),
+                "labels": obj.get("labels"),
+                "state": obj.get("state"),
+                "type": obj.get("type") if obj.get("type") is not None else UserType.INTAKE,
+                "user": obj.get("user"),
+            }
+        )
+        return _obj