`airflow.providers.google.cloud.operators.stackdriver`¶

Module Contents¶

Classes¶

`StackdriverListAlertPoliciesOperator`	Fetches all the Alert Policies identified by the filter passed as filter parameter.
`StackdriverEnableAlertPoliciesOperator`	Enables one or more disabled alerting policies identified by filter parameter.
`StackdriverDisableAlertPoliciesOperator`	Disables one or more enabled alerting policies identified by filter parameter.
`StackdriverUpsertAlertOperator`	Creates a new alert or updates an existing policy identified the name field in the alerts parameter.
`StackdriverDeleteAlertOperator`	Deletes an alerting policy.
`StackdriverListNotificationChannelsOperator`	Fetches all the Notification Channels identified by the filter passed as filter parameter.
`StackdriverEnableNotificationChannelsOperator`	Enables one or more disabled alerting policies identified by filter parameter.
`StackdriverDisableNotificationChannelsOperator`	Disables one or more enabled notification channels identified by filter parameter.
`StackdriverUpsertNotificationChannelOperator`	Create a new notification or updates an existing notification channel.
`StackdriverDeleteNotificationChannelOperator`	Deletes a notification channel.

class airflow.providers.google.cloud.operators.stackdriver.StackdriverListAlertPoliciesOperator(*, format_=None, filter_=None, order_by=None, page_size=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Fetches all the Alert Policies identified by the filter passed as filter parameter.

The desired return type can be specified by the format parameter, the supported formats are “dict”, “json” and None which returns python dictionary, stringified JSON and protobuf respectively.

See also

For more information on how to use this operator, take a look at the guide: StackdriverListAlertPoliciesOperator

Parameters

format – (Optional) Desired output format of the result. The supported formats are “dict”, “json” and None which returns python dictionary, stringified JSON and protobuf respectively.
filter – If provided, this field specifies the criteria that must be met by alert policies to be included in the response. For more details, see https://cloud.google.com/monitoring/api/v3/sorting-and-filtering.
order_by (str | None) – A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order. For more details, see https://cloud.google.com/monitoring/api/v3/sorting-and-filtering.
page_size (int | None) – The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.
gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud Platform.
project_id (str) – The project to fetch alerts from.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

ui_color = '#e5ffcc'[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.stackdriver.StackdriverEnableAlertPoliciesOperator(*, filter_=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Enables one or more disabled alerting policies identified by filter parameter.

Inoperative in case the policy is already enabled.

See also

For more information on how to use this operator, take a look at the guide: StackdriverEnableAlertPoliciesOperator

Parameters

filter – If provided, this field specifies the criteria that must be met by alert policies to be enabled. For more details, see https://cloud.google.com/monitoring/api/v3/sorting-and-filtering.
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.
gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud Platform.
project_id (str) – The project in which alert needs to be enabled.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

ui_color = '#e5ffcc'[source]¶

template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.stackdriver.StackdriverDisableAlertPoliciesOperator(*, filter_=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Disables one or more enabled alerting policies identified by filter parameter.

Inoperative in case the policy is already disabled.

See also

For more information on how to use this operator, take a look at the guide: StackdriverDisableAlertPoliciesOperator

Parameters

filter – If provided, this field specifies the criteria that must be met by alert policies to be disabled. For more details, see https://cloud.google.com/monitoring/api/v3/sorting-and-filtering.
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.
gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud Platform.
project_id (str) – The project in which alert needs to be disabled.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

ui_color = '#e5ffcc'[source]¶

template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.stackdriver.StackdriverUpsertAlertOperator(*, alerts, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Creates a new alert or updates an existing policy identified the name field in the alerts parameter.

See also

For more information on how to use this operator, take a look at the guide: StackdriverUpsertAlertOperator

Parameters

alerts (str) – A JSON string or file that specifies all the alerts that needs to be either created or updated. For more details, see https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.alertPolicies#AlertPolicy. (templated)
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.
gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud Platform.
project_id (str) – The project in which alert needs to be created/updated.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields: collections.abc.Sequence[str] = ('alerts', 'impersonation_chain')[source]¶

template_ext: collections.abc.Sequence[str] = ('.json',)[source]¶

operator_extra_links = ()[source]¶

ui_color = '#e5ffcc'[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.stackdriver.StackdriverDeleteAlertOperator(*, name, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Deletes an alerting policy.

See also

For more information on how to use this operator, take a look at the guide: StackdriverDeleteAlertOperator

Parameters

name (str) – The alerting policy to delete. The format is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID].
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.
gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud Platform.
project_id (str) – The project from which alert needs to be deleted.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields: collections.abc.Sequence[str] = ('name', 'impersonation_chain')[source]¶

ui_color = '#e5ffcc'[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.stackdriver.StackdriverListNotificationChannelsOperator(*, format_=None, filter_=None, order_by=None, page_size=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Fetches all the Notification Channels identified by the filter passed as filter parameter.

The desired return type can be specified by the format parameter, the supported formats are “dict”, “json” and None which returns python dictionary, stringified JSON and protobuf respectively.

See also

For more information on how to use this operator, take a look at the guide: StackdriverListNotificationChannelsOperator

Parameters

format – (Optional) Desired output format of the result. The supported formats are “dict”, “json” and None which returns python dictionary, stringified JSON and protobuf respectively.
filter – If provided, this field specifies the criteria that must be met by notification channels to be included in the response. For more details, see https://cloud.google.com/monitoring/api/v3/sorting-and-filtering.
order_by (str | None) – A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order. For more details, see https://cloud.google.com/monitoring/api/v3/sorting-and-filtering.
page_size (int | None) – The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.
gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud Platform.
project_id (str) – The project to fetch notification channels from.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

ui_color = '#e5ffcc'[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.stackdriver.StackdriverEnableNotificationChannelsOperator(*, filter_=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Enables one or more disabled alerting policies identified by filter parameter.

Inoperative in case the policy is already enabled.

See also

For more information on how to use this operator, take a look at the guide: StackdriverEnableNotificationChannelsOperator

Parameters

filter – If provided, this field specifies the criteria that must be met by notification channels to be enabled. For more details, see https://cloud.google.com/monitoring/api/v3/sorting-and-filtering.
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.
gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud Platform.
project_id (str) – The location used for the operation.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

ui_color = '#e5ffcc'[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.stackdriver.StackdriverDisableNotificationChannelsOperator(*, filter_=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Disables one or more enabled notification channels identified by filter parameter.

Inoperative in case the policy is already disabled.

See also

For more information on how to use this operator, take a look at the guide: StackdriverDisableNotificationChannelsOperator

Parameters

filter – If provided, this field specifies the criteria that must be met by alert policies to be disabled. For more details, see https://cloud.google.com/monitoring/api/v3/sorting-and-filtering.
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.
gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud Platform.
project_id (str) – The project in which notification channels needs to be enabled.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

ui_color = '#e5ffcc'[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.stackdriver.StackdriverUpsertNotificationChannelOperator(*, channels, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Create a new notification or updates an existing notification channel.

Channel is identified by the name field in the alerts parameter.

See also

For more information on how to use this operator, take a look at the guide: StackdriverUpsertNotificationChannelOperator

Parameters

channels (str) – A JSON string or file that specifies all the alerts that needs to be either created or updated. For more details, see https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannels. (templated)
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.
gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud Platform.
project_id (str) – The project in which notification channels needs to be created/updated.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields: collections.abc.Sequence[str] = ('channels', 'impersonation_chain')[source]¶

template_ext: collections.abc.Sequence[str] = ('.json',)[source]¶

operator_extra_links = ()[source]¶

ui_color = '#e5ffcc'[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.stackdriver.StackdriverDeleteNotificationChannelOperator(*, name, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Deletes a notification channel.

See also

For more information on how to use this operator, take a look at the guide: StackdriverDeleteNotificationChannelOperator

Parameters

name (str) – The alerting policy to delete. The format is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID].
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.
gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud Platform.
project_id (str) – The project from which notification channel needs to be deleted.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields: collections.abc.Sequence[str] = ('name', 'impersonation_chain')[source]¶

ui_color = '#e5ffcc'[source]¶

execute(context)[source]¶

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

airflow.providers.google.cloud.operators.stackdriver¶

Module Contents¶

Classes¶

`airflow.providers.google.cloud.operators.stackdriver`¶