CloudTasksQueueUpdateOperator

Google

Updates a queue in Cloud Tasks.

View Source

Last Updated: Jan. 14, 2021

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

task_queuedict or google.cloud.tasks_v2.types.QueueThe task queue to update. This method creates the queue if it does not exist and updates the queue if it does exist. The queue's name must be specified.
project_idstr(Optional) The ID of the Google Cloud project that owns the Cloud Tasks. If set to None or missing, the default project_id from the Google Cloud connection is used.
locationstr(Optional) The location name in which the queue will be updated. If provided, it will be used to construct the full queue path.
queue_namestr(Optional) The queue's name. If provided, it will be used to construct the full queue path.
update_maskdict or google.cloud.tasks_v2.types.FieldMaskA mast used to specify which fields of the queue are being updated. If empty, then all fields will be updated. If a dict is provided, it must be of the same form as the protobuf message.
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.
gcp_conn_idstr(Optional) The connection ID used to connect to Google Cloud.
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

Updates a queue in Cloud Tasks.

Example DAGs

Improve this module by creating an example DAG.

View Source
  1. Add an `example_dags` directory to the top-level source of the provider package with an empty `__init__.py` file.
  2. Add your DAG to this directory. Be sure to include a well-written and descriptive docstring
  3. Create a pull request against the source code. Once the package gets released, your DAG will show up on the Registry.

Was this page helpful?