airflow.providers.google.cloud.hooks.stackdriver

此模块包含 Google Cloud Stackdriver 运算符。

类

StackdriverHook

用于连接 Google Cloud Stackdriver 的 Stackdriver Hook。

模块内容

class airflow.providers.google.cloud.hooks.stackdriver.StackdriverHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

基类: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

用于连接 Google Cloud Stackdriver 的 Stackdriver Hook。

list_alert_policies(project_id=PROVIDE_PROJECT_ID, format_=None, filter_=None, order_by=None, page_size=None, retry=DEFAULT, timeout=None, metadata=())[source]

根据作为 filter 参数传递的过滤器，获取所有 Alert Policies。

期望的返回类型可以通过 format 参数指定，支持的格式有“dict”、“json”和 None，分别返回 python 字典、字符串化 JSON 和 protobuf。

参数:

  • format – （可选）结果的期望输出格式。支持的格式有“dict”、“json”和 None，分别返回 python 字典、字符串化 JSON 和 protobuf。

  • filter – 如果提供，此字段指定警报策略必须满足的标准，以便包含在响应中。有关更多详细信息，请参阅 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • order_by (str | None) – 用于对结果进行排序的字段的逗号分隔列表。支持与 filter 字段相同的字段引用集。条目可以以减号作为前缀，以按降序排列字段。有关更多详细信息，请参阅 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • page_size (int | None) – 基础 API 响应中包含的最大资源数量。如果每资源执行页面流式传输，此参数不影响返回值。如果每页执行页面流式传输，此参数确定一页中的最大资源数量。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定 None，将使用默认配置重试请求。

  • timeout (float | None) – 等待请求完成的时间，以秒为单位。请注意，如果指定了 retry，则超时应用于每个单独的尝试。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的额外元数据。

  • project_id (str) – 要从中获取警报的项目。

enable_alert_policies(project_id=PROVIDE_PROJECT_ID, filter_=None, retry=DEFAULT, timeout=None, metadata=())[source]

启用一个或多个由 filter 参数标识的已禁用警报策略。

如果策略已启用，则此操作无效。

参数:

  • project_id (str) – 需要启用警报的项目。

  • filter – 如果提供，此字段指定警报策略必须满足的标准，以便启用。有关更多详细信息，请参阅 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定 None，将使用默认配置重试请求。

  • timeout (float | None) – 等待请求完成的时间，以秒为单位。请注意，如果指定了 retry，则超时应用于每个单独的尝试。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的额外元数据。

disable_alert_policies(project_id=PROVIDE_PROJECT_ID, filter_=None, retry=DEFAULT, timeout=None, metadata=())[source]

禁用一个或多个由 filter 参数标识的已启用警报策略。

如果策略已禁用，则此操作无效。

参数:

  • project_id (str) – 需要禁用警报的项目。

  • filter – 如果提供，此字段指定警报策略必须满足的标准，以便禁用。有关更多详细信息，请参阅 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定 None，将使用默认配置重试请求。

  • timeout (float | None) – 等待请求完成的时间，以秒为单位。请注意，如果指定了 retry，则超时应用于每个单独的尝试。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的额外元数据。

upsert_alert(alerts, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

创建一个新警报或更新由 alerts 参数中的 name 字段标识的现有策略。

参数:
delete_alert_policy(name, retry=DEFAULT, timeout=None, metadata=())[source]

删除警报策略。

参数:

  • name (str) – 要删除的警报策略。格式为：projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定 None，将使用默认配置重试请求。

  • timeout (float | None) – 等待请求完成的时间，以秒为单位。请注意，如果指定了 retry，则超时应用于每个单独的尝试。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的额外元数据。

list_notification_channels(project_id=PROVIDE_PROJECT_ID, format_=None, filter_=None, order_by=None, page_size=None, retry=DEFAULT, timeout=None, metadata=())[source]

根据作为 filter 参数传递的过滤器，获取所有 Notification Channels。

期望的返回类型可以通过 format 参数指定，支持的格式有“dict”、“json”和 None，分别返回 python 字典、字符串化 JSON 和 protobuf。

参数:

  • format – （可选）结果的期望输出格式。支持的格式有“dict”、“json”和 None，分别返回 python 字典、字符串化 JSON 和 protobuf。

  • filter – 如果提供，此字段指定通知渠道必须满足的标准，以便包含在响应中。有关更多详细信息，请参阅 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • order_by (str | None) – 用于对结果进行排序的字段的逗号分隔列表。支持与 filter 字段相同的字段引用集。条目可以以减号作为前缀，以按降序排列字段。有关更多详细信息，请参阅 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • page_size (int | None) – 基础 API 响应中包含的最大资源数量。如果每资源执行页面流式传输，此参数不影响返回值。如果每页执行页面流式传输，此参数确定一页中的最大资源数量。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定 None，将使用默认配置重试请求。

  • timeout (float | None) – 等待请求完成的时间，以秒为单位。请注意，如果指定了 retry，则超时应用于每个单独的尝试。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的额外元数据。

  • project_id (str) – 要从中获取通知渠道的项目。

enable_notification_channels(project_id=PROVIDE_PROJECT_ID, filter_=None, retry=DEFAULT, timeout=None, metadata=())[source]

启用一个或多个由 filter 参数标识的已禁用警报策略。

如果策略已启用，则此操作无效。

参数:

  • project_id (str) – 需要启用通知渠道的项目。

  • filter – 如果提供，此字段指定通知渠道必须满足的标准，以便启用。有关更多详细信息，请参阅 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定 None，将使用默认配置重试请求。

  • timeout (float | None) – 等待请求完成的时间，以秒为单位。请注意，如果指定了 retry，则超时应用于每个单独的尝试。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的额外元数据。

disable_notification_channels(project_id, filter_=None, retry=DEFAULT, timeout=None, metadata=())[source]

禁用一个或多个由 filter 参数标识的已启用通知渠道。

如果策略已禁用，则此操作无效。

参数:

  • project_id (str) – 需要启用通知渠道的项目。

  • filter – 如果提供，此字段指定警报策略必须满足的标准，以便禁用。有关更多详细信息，请参阅 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定 None，将使用默认配置重试请求。

  • timeout (float | None) – 等待请求完成的时间，以秒为单位。请注意，如果指定了 retry，则超时应用于每个单独的尝试。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的额外元数据。

upsert_channel(channels, project_id, retry=DEFAULT, timeout=None, metadata=())[source]

创建新通知或更新现有通知渠道。

渠道由 alerts 参数中的 name 字段标识。

参数:
delete_notification_channel(name, retry=DEFAULT, timeout=None, metadata=())[source]

删除通知渠道。

参数:

  • name (str) – 要删除的警报策略。格式为：projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定 None，将使用默认配置重试请求。

  • timeout (float | None) – 等待请求完成的时间，以秒为单位。请注意，如果指定了 retry，则超时应用于每个单独的尝试。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的额外元数据。

此条目有帮助吗？