stackit-telemetrylink 0.1.0__py3-none-any.whl

src/stackit/telemetrylink/models/telemetry_link_request.py

@@ -0,0 +1,138 @@
+# coding: utf-8
+
+"""
+    STACKIT Telemetry Link API
+
+    This API provides endpoints for managing Telemetry Links. The Telemetry Link enables Log Routing towards a defined Telemetry Router. 
+
+    The version of the OpenAPI document: 1beta.0.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
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator
+from pydantic_core import to_jsonable_python
+from typing_extensions import Annotated, Self
+
+
+class TelemetryLinkRequest(BaseModel):
+    """
+    TelemetryLinkRequest
+    """  # noqa: E501
+
+    access_token: Optional[Annotated[str, Field(strict=True)]] = Field(
+        default=None, description="The access token.", alias="accessToken"
+    )
+    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: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=32)]] = Field(
+        default=None,
+        description="The display name is a short name chosen by the user to identify the resource.",
+        alias="displayName",
+    )
+    enabled: Optional[StrictBool] = Field(
+        default=True, description="Indicates whether routing through the link to a telemetry-router is active."
+    )
+    telemetry_router_id: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
+        default=None,
+        description="The ID of the telemetry-router to route the telemetry data.",
+        alias="telemetryRouterId",
+    )
+    __properties: ClassVar[List[str]] = ["accessToken", "description", "displayName", "enabled", "telemetryRouterId"]
+
+    @field_validator("access_token")
+    def access_token_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not isinstance(value, str):
+            value = str(value)
+
+        if not re.match(r"^[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0-9-_.+\/=]*$", value):
+            raise ValueError(
+                r"must validate the regular expression /^[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0-9-_.+\/=]*$/"
+            )
+        return value
+
+    @field_validator("display_name")
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not isinstance(value, str):
+            value = str(value)
+
+        if not re.match(r"^[a-zA-Z0-9][a-zA-Z0-9 \-]*$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9][a-zA-Z0-9 \-]*$/")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of TelemetryLinkRequest 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 TelemetryLinkRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "accessToken": obj.get("accessToken"),
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "enabled": obj.get("enabled") if obj.get("enabled") is not None else True,
+                "telemetryRouterId": obj.get("telemetryRouterId"),
+            }
+        )
+        return _obj

src/stackit/telemetrylink/models/telemetry_link_response.py

@@ -0,0 +1,158 @@
+# coding: utf-8
+
+"""
+    STACKIT Telemetry Link API
+
+    This API provides endpoints for managing Telemetry Links. The Telemetry Link enables Log Routing towards a defined Telemetry Router. 
+
+    The version of the OpenAPI document: 1beta.0.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
+import re  # noqa: F401
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set
+from uuid import UUID
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    StrictBool,
+    StrictStr,
+    field_validator,
+)
+from pydantic_core import to_jsonable_python
+from typing_extensions import Annotated, Self
+
+
+class TelemetryLinkResponse(BaseModel):
+    """
+    TelemetryLinkResponse
+    """  # noqa: E501
+
+    access_token: Optional[StrictStr] = Field(default=None, description="The access token.", alias="accessToken")
+    create_time: datetime = Field(description="The point in time the resource was created.", alias="createTime")
+    description: Optional[StrictStr] = 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"
+    )
+    enabled: StrictBool = Field(
+        description="Indicates whether routing through the link to a telemetry-router is active."
+    )
+    id: UUID = Field(description="A auto generated unique id which identifies the resource.")
+    region_id: StrictStr = Field(description="The STACKIT region name the resource is located in.", alias="regionId")
+    status: StrictStr = Field(description="The current state of the link.")
+    telemetry_router_id: Annotated[str, Field(strict=True, max_length=1024)] = Field(
+        description="The ID of the telemetry-router to route the telemetry data.", alias="telemetryRouterId"
+    )
+    __properties: ClassVar[List[str]] = [
+        "accessToken",
+        "createTime",
+        "description",
+        "displayName",
+        "enabled",
+        "id",
+        "regionId",
+        "status",
+        "telemetryRouterId",
+    ]
+
+    @field_validator("create_time", mode="before")
+    def create_time_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("region_id")
+    def region_id_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["eu01", "eu02"]):
+            raise ValueError("must be one of enum values ('eu01', 'eu02')")
+        return value
+
+    @field_validator("status")
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["active", "inactive", "failed", "reconciling", "deleting"]):
+            raise ValueError("must be one of enum values ('active', 'inactive', 'failed', 'reconciling', 'deleting')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of TelemetryLinkResponse 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 TelemetryLinkResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "accessToken": obj.get("accessToken"),
+                "createTime": obj.get("createTime"),
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "enabled": obj.get("enabled"),
+                "id": obj.get("id"),
+                "regionId": obj.get("regionId"),
+                "status": obj.get("status"),
+                "telemetryRouterId": obj.get("telemetryRouterId"),
+            }
+        )
+        return _obj

src/stackit/telemetrylink/rest.py

@@ -0,0 +1,164 @@
+# coding: utf-8
+
+"""
+    STACKIT Telemetry Link API
+
+    This API provides endpoints for managing Telemetry Links. The Telemetry Link enables Log Routing towards a defined Telemetry Router. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+import io
+import json
+import re
+
+import requests
+from stackit.core.authorization import Authorization
+from stackit.core.configuration import Configuration
+
+from stackit.telemetrylink.exceptions import ApiException, ApiValueError
+
+
+RESTResponseType = requests.Response
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status_code
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.content
+        return self.data
+
+    @property
+    def headers(self):
+        """Returns a dictionary of response headers."""
+        return self.response.headers
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers; use ``headers`` instead."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header; use ``headers.get()`` instead."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+    def __init__(self, config: Configuration) -> None:
+        self.session = config.custom_http_session if config.custom_http_session else requests.Session()
+        authorization = Authorization(config)
+        self.session.auth = authorization.auth_method
+
+    def request(self, method, url, headers=None, body=None, post_params=None, _request_timeout=None):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        if method not in ["GET", "HEAD", "DELETE", "POST", "PUT", "PATCH", "OPTIONS"]:
+            raise ValueError("Method %s not allowed", method)
+
+        if post_params and body:
+            raise ApiValueError("body parameter cannot be used with post_params parameter.")
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ["POST", "PUT", "PATCH", "OPTIONS", "DELETE"]:
+
+                # no content type provided or payload is json
+                content_type = headers.get("Content-Type")
+                if not content_type or re.search("json", content_type, re.IGNORECASE):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=request_body,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                elif content_type == "application/x-www-form-urlencoded":
+                    r = self.session.request(
+                        method,
+                        url,
+                        params=post_params,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                elif content_type == "multipart/form-data":
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers["Content-Type"]
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a, b) for a, b in post_params]
+                    r = self.session.request(
+                        method,
+                        url,
+                        files=post_params,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=body,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                elif headers["Content-Type"].startswith("text/") and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.session.request(
+                        method,
+                        url,
+                        data=request_body,
+                        headers=headers,
+                        timeout=_request_timeout,
+                    )
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.session.request(
+                    method,
+                    url,
+                    params={},
+                    headers=headers,
+                    timeout=_request_timeout,
+                )
+        except requests.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

stackit_telemetrylink-0.1.0.dist-info/METADATA

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: stackit-telemetrylink
+Version: 0.1.0
+Summary: STACKIT Telemetry Link API
+Project-URL: Homepage, https://github.com/stackitcloud/stackit-sdk-python
+Project-URL: Issues, https://github.com/stackitcloud/stackit-sdk-python/issues
+Author-email: STACKIT Developer Tools <developer-tools@stackit.cloud>
+License-File: LICENSE.md
+License-File: NOTICE.txt
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <4.0,>=3.9
+Requires-Dist: pydantic>=2.9.2
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: requests>=2.32.3
+Requires-Dist: stackit-core>=0.0.1a
+Description-Content-Type: text/markdown
+
+# stackit.telemetrylink
+This API provides endpoints for managing Telemetry Links. The Telemetry Link enables Log Routing towards a defined Telemetry Router.
+
+
+
+This package is part of the STACKIT Python SDK. For additional information, please visit the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK.
+
+
+## Installation & Usage
+### pip install
+
+```sh
+pip install stackit-telemetrylink
+```
+
+Then import the package:
+```python
+import stackit.telemetrylink
+```
+
+## Getting Started
+
+[Examples](https://github.com/stackitcloud/stackit-sdk-python/tree/main/examples) for the usage of the package can be found in the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK.

stackit_telemetrylink-0.1.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+src/stackit/telemetrylink/__init__.py,sha256=4S5gMnVkGHm6QD68mCRM3f8EBfldRuHa93gEMKsXYc0,3322
+src/stackit/telemetrylink/api_client.py,sha256=gryzuz2fhP3RA0mdtANKgs74HXBu2V7x2Z7lAFJAgM8,23825
+src/stackit/telemetrylink/api_response.py,sha256=HRYkVqMNIlfODacTQPTbiVj2YdcnutpQrKJdeAoCSpM,642
+src/stackit/telemetrylink/configuration.py,sha256=FR7_KwY6tM78d4bXZ3a03MLVmJfDOBqYF9tEuEc5Kbs,5756
+src/stackit/telemetrylink/exceptions.py,sha256=7vsIs3IHzqXFin4CsT4Jq2buSEPJAVcElxSZcxpzIWo,6467
+src/stackit/telemetrylink/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/stackit/telemetrylink/rest.py,sha256=3GxrDGT-VO6ZlvVOigxFNylITumNKb4t0buv27abuTo,6463
+src/stackit/telemetrylink/api/__init__.py,sha256=lcU6Aa86261uPDt9pnMoulKv3w43HOfULSWtj2BY-GY,108
+src/stackit/telemetrylink/api/default_api.py,sha256=f307jbX9Tk4kNnJlAhVV7X3feqnwfnKGGUb-IyLQL_8,151998
+src/stackit/telemetrylink/models/__init__.py,sha256=yKyJurrm7XJVgfEdzh8cSg-lblH17T7nQyWTh4sKln4,1501
+src/stackit/telemetrylink/models/create_or_update_folder_telemetry_link_payload.py,sha256=75ZjRsRC35egAKz5RgIfwSMkYlQxedRqNVNjhJxCFqM,4801
+src/stackit/telemetrylink/models/create_or_update_organization_telemetry_link_payload.py,sha256=u8GKnfw8U2Bu4OwL07ArNXsyIyFFdjBF3bqku5AG6KQ,4825
+src/stackit/telemetrylink/models/create_or_update_project_telemetry_link_payload.py,sha256=_qd5GNYc42FOlaffQ4ZisCEnu4gxdnd9uRgp9JSRiNs,4805
+src/stackit/telemetrylink/models/partial_update_folder_telemetry_link_payload.py,sha256=dy9W0gZxBJtVLj5YnZ77dAe8ZZWRZDY9FUphuhajY6o,5045
+src/stackit/telemetrylink/models/partial_update_organization_telemetry_link_payload.py,sha256=KrgWEf-9U8g42UcTyutA7ZFDlRbf1789bd8N2MLft58,5069
+src/stackit/telemetrylink/models/partial_update_project_telemetry_link_payload.py,sha256=92vaBKtsQm8TsjArDmDojWTdaFixFY0fXRXFmldHFO0,5049
+src/stackit/telemetrylink/models/response4xx.py,sha256=JauyrnJ6O-vghglJGL4Gr92SM6O__xQE9rjblblAJWo,2527
+src/stackit/telemetrylink/models/telemetry_link_request.py,sha256=Y8zct6S26XHT_54BJGwZamUA8i54X3thQUj-luDqzXM,4969
+src/stackit/telemetrylink/models/telemetry_link_response.py,sha256=NaywliFc173OIfMRPQ-yGcnDHa_7teKqRMvKau6VKlc,5826
+stackit_telemetrylink-0.1.0.dist-info/METADATA,sha256=cLnF6r41PhOfV39WGMQQRWnrKWbv8ng66hhJdsAisMk,1777
+stackit_telemetrylink-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+stackit_telemetrylink-0.1.0.dist-info/licenses/LICENSE.md,sha256=bxVEBCY6jGvAUq3_nmX12ZB8QzOWIggH_0dVHa9_dyc,10933
+stackit_telemetrylink-0.1.0.dist-info/licenses/NOTICE.txt,sha256=NESBPFtqggnWcQq_yq03rT2nMyTAoZ4cCqvMSlUE0yk,67
+stackit_telemetrylink-0.1.0.dist-info/RECORD,,

stackit_telemetrylink-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any