stackit-logs 0.1.0__py3-none-any.whl

stackit/logs/models/create_access_token_payload.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+"""
+    STACKIT Logs API
+
+    This API provides endpoints for managing STACKIT Logs. 
+
+    The version of the OpenAPI document: 1beta.0.3
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+
+class CreateAccessTokenPayload(BaseModel):
+    """
+    CreateAccessTokenPayload
+    """  # noqa: E501
+
+    description: Optional[Annotated[str, Field(strict=True, max_length=100)]] = Field(
+        default=None, description="The description of the access token."
+    )
+    display_name: Annotated[str, Field(min_length=1, strict=True, max_length=32)] = Field(
+        description="The displayed name of the access token.", alias="displayName"
+    )
+    lifetime: Optional[Annotated[int, Field(le=180, strict=True, ge=1)]] = Field(
+        default=None, description="A lifetime period for an access token in days. If unset the token will not expire."
+    )
+    permissions: List[StrictStr] = Field(description="The access permissions granted to the access token.")
+    __properties: ClassVar[List[str]] = ["description", "displayName", "lifetime", "permissions"]
+
+    @field_validator("display_name")
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z][\w -]*$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z][\w -]*$/")
+        return value
+
+    @field_validator("permissions")
+    def permissions_validate_enum(cls, value):
+        """Validates the enum"""
+        for i in value:
+            if i not in set(["read", "write"]):
+                raise ValueError("each list item must be one of ('read', 'write')")
+        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 CreateAccessTokenPayload 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 CreateAccessTokenPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "lifetime": obj.get("lifetime"),
+                "permissions": obj.get("permissions"),
+            }
+        )
+        return _obj

stackit/logs/models/create_logs_instance_payload.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+    STACKIT Logs API
+
+    This API provides endpoints for managing STACKIT Logs. 
+
+    The version of the OpenAPI document: 1beta.0.3
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+
+class CreateLogsInstancePayload(BaseModel):
+    """
+    CreateLogsInstancePayload
+    """  # noqa: E501
+
+    acl: Optional[List[StrictStr]] = Field(default=None, description="The access control list for the Logs instance.")
+    description: Optional[Annotated[str, Field(strict=True, max_length=100)]] = Field(
+        default=None, description="The description of the access token."
+    )
+    display_name: Annotated[str, Field(min_length=1, strict=True, max_length=32)] = Field(
+        description="The displayed name to distinguish multiple Logs instances.", alias="displayName"
+    )
+    retention_days: Annotated[int, Field(le=180, strict=True, ge=1)] = Field(
+        description="The log retention time in days.", alias="retentionDays"
+    )
+    __properties: ClassVar[List[str]] = ["acl", "description", "displayName", "retentionDays"]
+
+    @field_validator("display_name")
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z][\w -]*$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z][\w -]*$/")
+        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 CreateLogsInstancePayload 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 CreateLogsInstancePayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "acl": obj.get("acl"),
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "retentionDays": obj.get("retentionDays"),
+            }
+        )
+        return _obj

stackit/logs/models/logs_instance.py

@@ -0,0 +1,165 @@
+# coding: utf-8
+
+"""
+    STACKIT Logs API
+
+    This API provides endpoints for managing STACKIT Logs. 
+
+    The version of the OpenAPI document: 1beta.0.3
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+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
+
+
+class LogsInstance(BaseModel):
+    """
+    LogsInstance
+    """  # noqa: E501
+
+    acl: Optional[List[StrictStr]] = Field(default=None, description="The access control list for the Logs instance.")
+    created: datetime = Field(description="The date and time the creation of the Logs instance was triggered.")
+    datasource_url: Optional[StrictStr] = Field(
+        default=None,
+        description="The Logs instance's datasource URL, can be used in Grafana as a datasource URL",
+        alias="datasourceUrl",
+    )
+    description: Optional[Annotated[str, Field(strict=True, max_length=100)]] = Field(
+        default=None, description="The description of the Logs instance."
+    )
+    display_name: Annotated[str, Field(min_length=1, strict=True, max_length=32)] = Field(
+        description="The displayed name of the Logs instance.", alias="displayName"
+    )
+    id: StrictStr = Field(description="A auto generated unique id which identifies the Logs instance.")
+    ingest_otlp_url: Optional[StrictStr] = Field(
+        default=None, description="The Logs instance's ingest logs via OTLP URL", alias="ingestOtlpUrl"
+    )
+    ingest_url: Optional[StrictStr] = Field(
+        default=None, description="The Logs instance's ingest logs URL", alias="ingestUrl"
+    )
+    query_range_url: Optional[StrictStr] = Field(
+        default=None, description="The Logs instance's query range URL", alias="queryRangeUrl"
+    )
+    query_url: Optional[StrictStr] = Field(default=None, description="The Logs instance's query  URL", alias="queryUrl")
+    retention_days: Annotated[int, Field(le=180, strict=True, ge=1)] = Field(
+        description="The log retention time in days.", alias="retentionDays"
+    )
+    status: StrictStr = Field(description="The current status of the Logs instance.")
+    __properties: ClassVar[List[str]] = [
+        "acl",
+        "created",
+        "datasourceUrl",
+        "description",
+        "displayName",
+        "id",
+        "ingestOtlpUrl",
+        "ingestUrl",
+        "queryRangeUrl",
+        "queryUrl",
+        "retentionDays",
+        "status",
+    ]
+
+    @field_validator("created", mode="before")
+    def created_change_year_zero_to_one(cls, value):
+        """Workaround which prevents year 0 issue"""
+        if isinstance(value, str):
+            # Check for year "0000" at the beginning of the string
+            # This assumes common date formats like YYYY-MM-DDTHH:MM:SS+00:00 or YYYY-MM-DDTHH:MM:SSZ
+            if value.startswith("0000-01-01T") and re.match(
+                r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\+\d{2}:\d{2}|Z)$", value
+            ):
+                # Workaround: Replace "0000" with "0001"
+                return "0001" + value[4:]  # Take "0001" and append the rest of the string
+        return value
+
+    @field_validator("display_name")
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z][\w -]*$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z][\w -]*$/")
+        return value
+
+    @field_validator("status")
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["active", "deleting", "reconciling"]):
+            raise ValueError("must be one of enum values ('active', 'deleting', 'reconciling')")
+        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 LogsInstance 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 LogsInstance from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "acl": obj.get("acl"),
+                "created": obj.get("created"),
+                "datasourceUrl": obj.get("datasourceUrl"),
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "id": obj.get("id"),
+                "ingestOtlpUrl": obj.get("ingestOtlpUrl"),
+                "ingestUrl": obj.get("ingestUrl"),
+                "queryRangeUrl": obj.get("queryRangeUrl"),
+                "queryUrl": obj.get("queryUrl"),
+                "retentionDays": obj.get("retentionDays"),
+                "status": obj.get("status"),
+            }
+        )
+        return _obj

stackit/logs/models/logs_instances_list.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    STACKIT Logs API
+
+    This API provides endpoints for managing STACKIT Logs. 
+
+    The version of the OpenAPI document: 1beta.0.3
+    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
+from typing_extensions import Self
+
+from stackit.logs.models.logs_instance import LogsInstance
+
+
+class LogsInstancesList(BaseModel):
+    """
+    LogsInstancesList
+    """  # noqa: E501
+
+    instances: List[LogsInstance]
+    __properties: ClassVar[List[str]] = ["instances"]
+
+    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 LogsInstancesList 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 instances (list)
+        _items = []
+        if self.instances:
+            for _item in self.instances:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["instances"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of LogsInstancesList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "instances": (
+                    [LogsInstance.from_dict(_item) for _item in obj["instances"]]
+                    if obj.get("instances") is not None
+                    else None
+                )
+            }
+        )
+        return _obj

stackit/logs/models/update_access_token_payload.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    STACKIT Logs API
+
+    This API provides endpoints for managing STACKIT Logs. 
+
+    The version of the OpenAPI document: 1beta.0.3
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+from typing_extensions import Annotated, Self
+
+
+class UpdateAccessTokenPayload(BaseModel):
+    """
+    UpdateAccessTokenPayload
+    """  # noqa: E501
+
+    description: Optional[Annotated[str, Field(strict=True, max_length=100)]] = Field(
+        default=None, description="The description of the access token."
+    )
+    display_name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=32)]] = Field(
+        default=None, description="The displayed name of the access token.", alias="displayName"
+    )
+    __properties: ClassVar[List[str]] = ["description", "displayName"]
+
+    @field_validator("display_name")
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z][\w -]*$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z][\w -]*$/")
+        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 UpdateAccessTokenPayload 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 UpdateAccessTokenPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"description": obj.get("description"), "displayName": obj.get("displayName")})
+        return _obj

stackit/logs/models/update_logs_instance_payload.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+    STACKIT Logs API
+
+    This API provides endpoints for managing STACKIT Logs. 
+
+    The version of the OpenAPI document: 1beta.0.3
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+
+class UpdateLogsInstancePayload(BaseModel):
+    """
+    UpdateLogsInstancePayload
+    """  # noqa: E501
+
+    acl: Optional[List[StrictStr]] = Field(default=None, description="The access control list for the Logs instance.")
+    description: Optional[Annotated[str, Field(strict=True, max_length=100)]] = Field(
+        default=None, description="The description of the Logs instance."
+    )
+    display_name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=32)]] = Field(
+        default=None, description="The displayed name to distinguish multiple Logs instances.", alias="displayName"
+    )
+    retention_days: Optional[Annotated[int, Field(le=180, strict=True, ge=1)]] = Field(
+        default=None, description="The log retention time in days.", alias="retentionDays"
+    )
+    __properties: ClassVar[List[str]] = ["acl", "description", "displayName", "retentionDays"]
+
+    @field_validator("display_name")
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z][\w -]*$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z][\w -]*$/")
+        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 UpdateLogsInstancePayload 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 UpdateLogsInstancePayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "acl": obj.get("acl"),
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "retentionDays": obj.get("retentionDays"),
+            }
+        )
+        return _obj