PubSubDeleteSubscriptionOperator

Google

Delete a PubSub subscription.

View Source

Last Updated: Dec. 22, 2020

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

project_idstrOptional, the Google Cloud project ID in which to work (templated). If set to None or missing, the default project_id from the Google Cloud connection is used.
subscriptionstrthe subscription to delete. Do not include the full subscription path. In other words, instead of projects/{project}/subscription/{subscription}, provide only {subscription}. (templated)
fail_if_not_existsboolIf True and the subscription does not exist, fail the task
gcp_conn_idstrThe connection ID to use connecting to Google Cloud.
delegate_tostrThe account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.
retrygoogle.api_core.retry.Retry(Optional) A retry object used to retry requests. If None is specified, requests will not be retried.
timeoutfloat(Optional) 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.
metadataSequence[Tuple[str, str]]](Optional) Additional metadata that is provided to the method.
projectstr(Deprecated) the Google Cloud project ID where the topic will be created
impersonation_chainUnion[str, Sequence[str]]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).

Documentation

See also

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

By default, if the subscription does not exist, this operator will not cause the DAG to fail.

with DAG('successful DAG') as dag:
(
PubSubSubscriptionDeleteOperator(project='my-project',
subscription='non-existing')
)

The operator can be configured to fail if the subscription already exists.

with DAG('failing DAG') as dag:
(
PubSubSubscriptionDeleteOperator(
project='my-project', subscription='non-existing',
fail_if_not_exists=True)
)

project, and subscription are templated so you can use variables in them.

Was this page helpful?