honeycomb-api 0.1.0__py3-none-any.whl

honeycomb/_generated/models/slo_create.py

@@ -0,0 +1,245 @@
+from typing import Any, TypeVar, Optional, BinaryIO, TextIO, TYPE_CHECKING
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from ..types import UNSET, Unset
+from dateutil.parser import isoparse
+from typing import cast
+from typing import cast, Union
+from typing import Union
+import datetime
+
+if TYPE_CHECKING:
+  from ..models.slo_create_sli import SLOCreateSli
+  from ..models.tag import Tag
+
+
+
+
+
+T = TypeVar("T", bound="SLOCreate")
+
+
+
+@_attrs_define
+class SLOCreate:
+    """ 
+        Attributes:
+            name (str): The name of the SLO. Example: My SLO.
+            sli (SLOCreateSli): Reference to the [Calculated Field (also called Derived Column)](/api/calculated-fields/)
+                used as the indicator of event success. Example: {'alias': 'error_sli'}.
+            time_period_days (int): The time period, in days, over which the SLO will be evaluated. Example: 30.
+            target_per_million (int): The number of events out of one million (1,000,000) that you expected qualified events
+                to succeed. Example: 990000.
+            id (Union[Unset, str]):
+            description (Union[Unset, str]): A nice description of the SLO's intent and context. Example: SLO to ensure
+                requests succeed and are fast.
+            tags (Union[Unset, list['Tag']]): A list of key-value pairs to help identify the SLO. Example: [{'key': 'team',
+                'value': 'blue'}].
+            reset_at (Union[None, Unset, datetime.datetime]): The ISO8601-formatted time the SLO was last reset. The value
+                will be `null` if the SLO has not yet been reset. Example: 2022-011-11T09:53:04Z.
+            created_at (Union[Unset, datetime.datetime]): The ISO8601-formatted time when the SLO was created. Example:
+                2022-09-22T17:32:11Z.
+            updated_at (Union[Unset, datetime.datetime]): The ISO8601-formatted time when the SLO was updated. Example:
+                2022-10-31T15:08:11Z.
+            dataset_slugs (Union[Unset, list[str]]): The dataset(s) the SLO will be evaluated against. Required if using
+                `__all__` in the path. Example: ['mydataset1', 'mydataset2'].
+     """
+
+    name: str
+    sli: 'SLOCreateSli'
+    time_period_days: int
+    target_per_million: int
+    id: Union[Unset, str] = UNSET
+    description: Union[Unset, str] = UNSET
+    tags: Union[Unset, list['Tag']] = UNSET
+    reset_at: Union[None, Unset, datetime.datetime] = UNSET
+    created_at: Union[Unset, datetime.datetime] = UNSET
+    updated_at: Union[Unset, datetime.datetime] = UNSET
+    dataset_slugs: Union[Unset, list[str]] = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.slo_create_sli import SLOCreateSli
+        from ..models.tag import Tag
+        name = self.name
+
+        sli = self.sli.to_dict()
+
+        time_period_days = self.time_period_days
+
+        target_per_million = self.target_per_million
+
+        id = self.id
+
+        description = self.description
+
+        tags: Union[Unset, list[dict[str, Any]]] = UNSET
+        if not isinstance(self.tags, Unset):
+            tags = []
+            for tags_item_data in self.tags:
+                tags_item = tags_item_data.to_dict()
+                tags.append(tags_item)
+
+
+
+        reset_at: Union[None, Unset, str]
+        if isinstance(self.reset_at, Unset):
+            reset_at = UNSET
+        elif isinstance(self.reset_at, datetime.datetime):
+            reset_at = self.reset_at.isoformat()
+        else:
+            reset_at = self.reset_at
+
+        created_at: Union[Unset, str] = UNSET
+        if not isinstance(self.created_at, Unset):
+            created_at = self.created_at.isoformat()
+
+        updated_at: Union[Unset, str] = UNSET
+        if not isinstance(self.updated_at, Unset):
+            updated_at = self.updated_at.isoformat()
+
+        dataset_slugs: Union[Unset, list[str]] = UNSET
+        if not isinstance(self.dataset_slugs, Unset):
+            dataset_slugs = self.dataset_slugs
+
+
+
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({
+            "name": name,
+            "sli": sli,
+            "time_period_days": time_period_days,
+            "target_per_million": target_per_million,
+        })
+        if id is not UNSET:
+            field_dict["id"] = id
+        if description is not UNSET:
+            field_dict["description"] = description
+        if tags is not UNSET:
+            field_dict["tags"] = tags
+        if reset_at is not UNSET:
+            field_dict["reset_at"] = reset_at
+        if created_at is not UNSET:
+            field_dict["created_at"] = created_at
+        if updated_at is not UNSET:
+            field_dict["updated_at"] = updated_at
+        if dataset_slugs is not UNSET:
+            field_dict["dataset_slugs"] = dataset_slugs
+
+        return field_dict
+
+
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:
+        from ..models.slo_create_sli import SLOCreateSli
+        from ..models.tag import Tag
+        d = src_dict.copy()
+        name = d.pop("name")
+
+        sli = SLOCreateSli.from_dict(d.pop("sli"))
+
+
+
+
+        time_period_days = d.pop("time_period_days")
+
+        target_per_million = d.pop("target_per_million")
+
+        id = d.pop("id", UNSET)
+
+        description = d.pop("description", UNSET)
+
+        tags = []
+        _tags = d.pop("tags", UNSET)
+        for tags_item_data in (_tags or []):
+            tags_item = Tag.from_dict(tags_item_data)
+
+
+
+            tags.append(tags_item)
+
+
+        def _parse_reset_at(data: object) -> Union[None, Unset, datetime.datetime]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            try:
+                if not isinstance(data, str):
+                    raise TypeError()
+                reset_at_type_1 = isoparse(data)
+
+
+
+                return reset_at_type_1
+            except: # noqa: E722
+                pass
+            return cast(Union[None, Unset, datetime.datetime], data)
+
+        reset_at = _parse_reset_at(d.pop("reset_at", UNSET))
+
+
+        _created_at = d.pop("created_at", UNSET)
+        created_at: Union[Unset, datetime.datetime]
+        if isinstance(_created_at,  Unset):
+            created_at = UNSET
+        else:
+            created_at = isoparse(_created_at)
+
+
+
+
+        _updated_at = d.pop("updated_at", UNSET)
+        updated_at: Union[Unset, datetime.datetime]
+        if isinstance(_updated_at,  Unset):
+            updated_at = UNSET
+        else:
+            updated_at = isoparse(_updated_at)
+
+
+
+
+        dataset_slugs = cast(list[str], d.pop("dataset_slugs", UNSET))
+
+
+        slo_create = cls(
+            name=name,
+            sli=sli,
+            time_period_days=time_period_days,
+            target_per_million=target_per_million,
+            id=id,
+            description=description,
+            tags=tags,
+            reset_at=reset_at,
+            created_at=created_at,
+            updated_at=updated_at,
+            dataset_slugs=dataset_slugs,
+        )
+
+
+        slo_create.additional_properties = d
+        return slo_create
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

honeycomb/_generated/models/slo_create_sli.py

@@ -0,0 +1,75 @@
+from typing import Any, TypeVar, Optional, BinaryIO, TextIO, TYPE_CHECKING
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+
+
+
+
+
+
+T = TypeVar("T", bound="SLOCreateSli")
+
+
+
+@_attrs_define
+class SLOCreateSli:
+    """ Reference to the [Calculated Field (also called Derived Column)](/api/calculated-fields/) used as the indicator of
+    event success.
+
+        Example:
+            {'alias': 'error_sli'}
+
+        Attributes:
+            alias (str): The alias of the Calculated Field (also called Derived Column).
+     """
+
+    alias: str
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+
+    def to_dict(self) -> dict[str, Any]:
+        alias = self.alias
+
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({
+            "alias": alias,
+        })
+
+        return field_dict
+
+
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:
+        d = src_dict.copy()
+        alias = d.pop("alias")
+
+        slo_create_sli = cls(
+            alias=alias,
+        )
+
+
+        slo_create_sli.additional_properties = d
+        return slo_create_sli
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

honeycomb/_generated/models/slo_detailed_response.py

@@ -0,0 +1,312 @@
+from typing import Any, TypeVar, Optional, BinaryIO, TextIO, TYPE_CHECKING
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from ..models.slo_detailed_response_status import SLODetailedResponseStatus
+from ..types import UNSET, Unset
+from dateutil.parser import isoparse
+from typing import cast
+from typing import cast, Union
+from typing import Union
+import datetime
+
+if TYPE_CHECKING:
+  from ..models.slo_sli import SLOSli
+  from ..models.tag import Tag
+
+
+
+
+
+T = TypeVar("T", bound="SLODetailedResponse")
+
+
+
+@_attrs_define
+class SLODetailedResponse:
+    """ 
+        Attributes:
+            name (str): The name of the SLO. Example: My SLO.
+            sli (SLOSli): Reference to the [Calculated Field](/api/calculated-fields/) used as the indicator of event
+                success. Example: {'alias': 'error_sli'}.
+            time_period_days (int): The time period, in days, over which the SLO will be evaluated. Example: 30.
+            target_per_million (int): The number of events out of one million (1,000,000) that you expected qualified events
+                to succeed. Example: 990000.
+            id (Union[Unset, str]):
+            description (Union[Unset, str]): A nice description of the SLO's intent and context. Example: SLO to ensure
+                requests succeed and are fast.
+            tags (Union[Unset, list['Tag']]): A list of key-value pairs to help identify the SLO. Example: [{'key': 'team',
+                'value': 'blue'}].
+            reset_at (Union[None, Unset, datetime.datetime]): The ISO8601-formatted time the SLO was last reset. The value
+                will be `null` if the SLO has not yet been reset. Example: 2022-011-11T09:53:04Z.
+            created_at (Union[Unset, datetime.datetime]): The ISO8601-formatted time when the SLO was created. Example:
+                2022-09-22T17:32:11Z.
+            updated_at (Union[Unset, datetime.datetime]): The ISO8601-formatted time when the SLO was updated. Example:
+                2022-10-31T15:08:11Z.
+            dataset_slugs (Union[Unset, list[str]]): The dataset(s) the SLO will be evaluated against. Required if using
+                `__all__` in the path. Example: ['mydataset1', 'mydataset2'].
+            compliance (Union[Unset, float]): Reporting data to express historical compliance of the SLO. Only included when
+                the `?detailed` query param is passed.
+                 Example: 95.39.
+            budget_remaining (Union[Unset, float]): Reporting data to express how much error budget remains for the time
+                period of the SLO. Only included when the `?detailed` query param is passed.
+                 Example: 7.73.
+            status (Union[Unset, SLODetailedResponseStatus]): Reporting data to express the status of the SLO.
+
+                Status can be one of the following:
+                - `normal`   : The SLO has no burn alerts triggered.
+                - `triggered`: The SLO has at least one burn alert triggered.
+                - `no_alerts`: The SLO has no burn alerts associated with it.
+                - `no_events`: The SLO has no events streaming in.
+
+                Only included when the `?detailed` query param is passed.
+                 Example: normal.
+            burn_rate (Union[Unset, float]): Reporting data to express the ratio of actual failures in the SLO
+                to expected failures in the given time window.
+
+                The time window defaults to 4 hours for the API response.
+
+                Only included when the `?detailed` query param is passed.
+                 Example: 5.39.
+     """
+
+    name: str
+    sli: 'SLOSli'
+    time_period_days: int
+    target_per_million: int
+    id: Union[Unset, str] = UNSET
+    description: Union[Unset, str] = UNSET
+    tags: Union[Unset, list['Tag']] = UNSET
+    reset_at: Union[None, Unset, datetime.datetime] = UNSET
+    created_at: Union[Unset, datetime.datetime] = UNSET
+    updated_at: Union[Unset, datetime.datetime] = UNSET
+    dataset_slugs: Union[Unset, list[str]] = UNSET
+    compliance: Union[Unset, float] = UNSET
+    budget_remaining: Union[Unset, float] = UNSET
+    status: Union[Unset, SLODetailedResponseStatus] = UNSET
+    burn_rate: Union[Unset, float] = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.slo_sli import SLOSli
+        from ..models.tag import Tag
+        name = self.name
+
+        sli = self.sli.to_dict()
+
+        time_period_days = self.time_period_days
+
+        target_per_million = self.target_per_million
+
+        id = self.id
+
+        description = self.description
+
+        tags: Union[Unset, list[dict[str, Any]]] = UNSET
+        if not isinstance(self.tags, Unset):
+            tags = []
+            for tags_item_data in self.tags:
+                tags_item = tags_item_data.to_dict()
+                tags.append(tags_item)
+
+
+
+        reset_at: Union[None, Unset, str]
+        if isinstance(self.reset_at, Unset):
+            reset_at = UNSET
+        elif isinstance(self.reset_at, datetime.datetime):
+            reset_at = self.reset_at.isoformat()
+        else:
+            reset_at = self.reset_at
+
+        created_at: Union[Unset, str] = UNSET
+        if not isinstance(self.created_at, Unset):
+            created_at = self.created_at.isoformat()
+
+        updated_at: Union[Unset, str] = UNSET
+        if not isinstance(self.updated_at, Unset):
+            updated_at = self.updated_at.isoformat()
+
+        dataset_slugs: Union[Unset, list[str]] = UNSET
+        if not isinstance(self.dataset_slugs, Unset):
+            dataset_slugs = self.dataset_slugs
+
+
+
+        compliance = self.compliance
+
+        budget_remaining = self.budget_remaining
+
+        status: Union[Unset, str] = UNSET
+        if not isinstance(self.status, Unset):
+            status = self.status.value
+
+
+        burn_rate = self.burn_rate
+
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({
+            "name": name,
+            "sli": sli,
+            "time_period_days": time_period_days,
+            "target_per_million": target_per_million,
+        })
+        if id is not UNSET:
+            field_dict["id"] = id
+        if description is not UNSET:
+            field_dict["description"] = description
+        if tags is not UNSET:
+            field_dict["tags"] = tags
+        if reset_at is not UNSET:
+            field_dict["reset_at"] = reset_at
+        if created_at is not UNSET:
+            field_dict["created_at"] = created_at
+        if updated_at is not UNSET:
+            field_dict["updated_at"] = updated_at
+        if dataset_slugs is not UNSET:
+            field_dict["dataset_slugs"] = dataset_slugs
+        if compliance is not UNSET:
+            field_dict["compliance"] = compliance
+        if budget_remaining is not UNSET:
+            field_dict["budget_remaining"] = budget_remaining
+        if status is not UNSET:
+            field_dict["status"] = status
+        if burn_rate is not UNSET:
+            field_dict["burn_rate"] = burn_rate
+
+        return field_dict
+
+
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:
+        from ..models.slo_sli import SLOSli
+        from ..models.tag import Tag
+        d = src_dict.copy()
+        name = d.pop("name")
+
+        sli = SLOSli.from_dict(d.pop("sli"))
+
+
+
+
+        time_period_days = d.pop("time_period_days")
+
+        target_per_million = d.pop("target_per_million")
+
+        id = d.pop("id", UNSET)
+
+        description = d.pop("description", UNSET)
+
+        tags = []
+        _tags = d.pop("tags", UNSET)
+        for tags_item_data in (_tags or []):
+            tags_item = Tag.from_dict(tags_item_data)
+
+
+
+            tags.append(tags_item)
+
+
+        def _parse_reset_at(data: object) -> Union[None, Unset, datetime.datetime]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            try:
+                if not isinstance(data, str):
+                    raise TypeError()
+                reset_at_type_1 = isoparse(data)
+
+
+
+                return reset_at_type_1
+            except: # noqa: E722
+                pass
+            return cast(Union[None, Unset, datetime.datetime], data)
+
+        reset_at = _parse_reset_at(d.pop("reset_at", UNSET))
+
+
+        _created_at = d.pop("created_at", UNSET)
+        created_at: Union[Unset, datetime.datetime]
+        if isinstance(_created_at,  Unset):
+            created_at = UNSET
+        else:
+            created_at = isoparse(_created_at)
+
+
+
+
+        _updated_at = d.pop("updated_at", UNSET)
+        updated_at: Union[Unset, datetime.datetime]
+        if isinstance(_updated_at,  Unset):
+            updated_at = UNSET
+        else:
+            updated_at = isoparse(_updated_at)
+
+
+
+
+        dataset_slugs = cast(list[str], d.pop("dataset_slugs", UNSET))
+
+
+        compliance = d.pop("compliance", UNSET)
+
+        budget_remaining = d.pop("budget_remaining", UNSET)
+
+        _status = d.pop("status", UNSET)
+        status: Union[Unset, SLODetailedResponseStatus]
+        if isinstance(_status,  Unset):
+            status = UNSET
+        else:
+            status = SLODetailedResponseStatus(_status)
+
+
+
+
+        burn_rate = d.pop("burn_rate", UNSET)
+
+        slo_detailed_response = cls(
+            name=name,
+            sli=sli,
+            time_period_days=time_period_days,
+            target_per_million=target_per_million,
+            id=id,
+            description=description,
+            tags=tags,
+            reset_at=reset_at,
+            created_at=created_at,
+            updated_at=updated_at,
+            dataset_slugs=dataset_slugs,
+            compliance=compliance,
+            budget_remaining=budget_remaining,
+            status=status,
+            burn_rate=burn_rate,
+        )
+
+
+        slo_detailed_response.additional_properties = d
+        return slo_detailed_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

honeycomb/_generated/models/slo_detailed_response_status.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+class SLODetailedResponseStatus(str, Enum):
+    NORMAL = "normal"
+    NO_ALERTS = "no_alerts"
+    NO_EVENTS = "no_events"
+    TRIGGERED = "triggered"
+
+    def __str__(self) -> str:
+        return str(self.value)