airflow.providers.opsgenie.typing.opsgenie

Module Contents

Classes

CreateAlertPayload

Payload schema for creating an Opsgenie alert.
class airflow.providers.opsgenie.typing.opsgenie.CreateAlertPayload[source]

Bases: TypedDict

Payload schema for creating an Opsgenie alert.

Parameters

  • message – The Message of the Opsgenie alert.

  • alias – Client-defined identifier of the alert.

  • description – Description field of the alert.

  • responders – Teams, users, escalations and schedules that the alert will be routed to send notifications.

  • visible_to – Teams and users that the alert will become visible to without sending any notification.

  • actions – Custom actions that will be available for the alert.

  • tags – Tags of the alert.

  • details – Map of key-value pairs to use as custom properties of the alert.

  • entity – Entity field of the alert that is generally used to specify which domain alert is related to.

  • source – Source field of the alert. Default value is IP address of the incoming request.

  • priority – Priority level of the alert. Default value is P3.

  • user – Display name of the request owner.

  • note – Additional note that will be added while creating the alert.

message: typing_extensions.Required[str][source]
alias: typing_extensions.NotRequired[str | None][source]
description: typing_extensions.NotRequired[str | None][source]
responders: typing_extensions.NotRequired[list[dict] | None][source]
visible_to: typing_extensions.NotRequired[list[dict] | None][source]
actions: typing_extensions.NotRequired[list[str] | None][source]
tags: typing_extensions.NotRequired[list[str] | None][source]
details: typing_extensions.NotRequired[dict | None][source]
entity: typing_extensions.NotRequired[str | None][source]
source: typing_extensions.NotRequired[str | None][source]
priority: typing_extensions.NotRequired[str | None][source]
user: typing_extensions.NotRequired[str | None][source]
note: typing_extensions.NotRequired[str | None][source]

Was this entry helpful?