Skip to content

incident_io_client.models.alert_events_v2_create_http_request_body

AlertEventsV2CreateHTTPRequestBody

Example

{'deduplication_key': '4293868629', 'description': "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...", 'metadata': {'service': 'hello.world.com', 'team': ['my-team']}, 'source_url': 'https://www.my-alerting-platform.com/alerts/my-alert-123', 'status': 'firing', 'title': '*errors.withMessage: PG::Error failed to connect'}

Attributes:

Name Type Description
status AlertEventsV2CreateHTTPRequestBodyStatus

Current status of this alert Example: firing.
title str

Alert title which is used when summarising the alert Example: *errors.withMessage: PG::Error failed to connect.
deduplication_key Union[Unset, str]

A deduplication key can be provided to uniquely reference this alert from your alert source. If you send an event with the same deduplication_key multiple times, only one alert will be created in incident.io for this alert source config. Example: 4293868629.
description Union[Unset, str]

Description that optionally adds more detail to title. Supports markdown. Example: We've detected a number of timeouts on hello.world.com, the service may be down. To fix....
metadata Union[Unset, AlertEventsV2CreateHTTPRequestBodyMetadata]

Any additional metadata that you've configured your alert source to parse Example: {'service': 'hello.world.com', 'team': ['my-team']}.
source_url Union[Unset, str]

If applicable, a link to the alert in the upstream system Example: https://www.my-alerting-platform.com/alerts/my-alert-123.
Source code in incident_io_client/models/alert_events_v2_create_http_request_body.py 
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
@_attrs_define
class AlertEventsV2CreateHTTPRequestBody:
    """
    Example:
        {'deduplication_key': '4293868629', 'description': "We've detected a number of timeouts on hello.world.com, the
            service may be down. To fix...", 'metadata': {'service': 'hello.world.com', 'team': ['my-team']}, 'source_url':
            'https://www.my-alerting-platform.com/alerts/my-alert-123', 'status': 'firing', 'title': '*errors.withMessage:
            PG::Error failed to connect'}

    Attributes:
        status (AlertEventsV2CreateHTTPRequestBodyStatus): Current status of this alert Example: firing.
        title (str): Alert title which is used when summarising the alert Example: *errors.withMessage: PG::Error failed
            to connect.
        deduplication_key (Union[Unset, str]): A deduplication key can be provided to uniquely reference this alert from
            your alert source. If you send an event with the same deduplication_key multiple times, only one alert will be
            created in incident.io for this alert source config. Example: 4293868629.
        description (Union[Unset, str]): Description that optionally adds more detail to title. Supports markdown.
            Example: We've detected a number of timeouts on hello.world.com, the service may be down. To fix....
        metadata (Union[Unset, AlertEventsV2CreateHTTPRequestBodyMetadata]): Any additional metadata that you've
            configured your alert source to parse Example: {'service': 'hello.world.com', 'team': ['my-team']}.
        source_url (Union[Unset, str]): If applicable, a link to the alert in the upstream system Example:
            https://www.my-alerting-platform.com/alerts/my-alert-123.
    """

    status: AlertEventsV2CreateHTTPRequestBodyStatus
    title: str
    deduplication_key: Union[Unset, str] = UNSET
    description: Union[Unset, str] = UNSET
    metadata: Union[Unset, "AlertEventsV2CreateHTTPRequestBodyMetadata"] = UNSET
    source_url: Union[Unset, str] = UNSET
    additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)

    def to_dict(self) -> Dict[str, Any]:
        status = self.status.value

        title = self.title

        deduplication_key = self.deduplication_key

        description = self.description

        metadata: Union[Unset, Dict[str, Any]] = UNSET
        if not isinstance(self.metadata, Unset):
            metadata = self.metadata.to_dict()

        source_url = self.source_url

        field_dict: Dict[str, Any] = {}
        field_dict.update(self.additional_properties)
        field_dict.update(
            {
                "status": status,
                "title": title,
            }
        )
        if deduplication_key is not UNSET:
            field_dict["deduplication_key"] = deduplication_key
        if description is not UNSET:
            field_dict["description"] = description
        if metadata is not UNSET:
            field_dict["metadata"] = metadata
        if source_url is not UNSET:
            field_dict["source_url"] = source_url

        return field_dict

    @classmethod
    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
        from ..models.alert_events_v2_create_http_request_body_metadata import (
            AlertEventsV2CreateHTTPRequestBodyMetadata,
        )

        d = src_dict.copy()
        status = AlertEventsV2CreateHTTPRequestBodyStatus(d.pop("status"))

        title = d.pop("title")

        deduplication_key = d.pop("deduplication_key", UNSET)

        description = d.pop("description", UNSET)

        _metadata = d.pop("metadata", UNSET)
        metadata: Union[Unset, AlertEventsV2CreateHTTPRequestBodyMetadata]
        if isinstance(_metadata, Unset):
            metadata = UNSET
        else:
            metadata = AlertEventsV2CreateHTTPRequestBodyMetadata.from_dict(_metadata)

        source_url = d.pop("source_url", UNSET)

        alert_events_v2_create_http_request_body = cls(
            status=status,
            title=title,
            deduplication_key=deduplication_key,
            description=description,
            metadata=metadata,
            source_url=source_url,
        )

        alert_events_v2_create_http_request_body.additional_properties = d
        return alert_events_v2_create_http_request_body

    @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