airflow.providers.google.cloud.operators.tasks

This module contains various Google Cloud Tasks operators which allow you to perform basic operations using Cloud Tasks queues/tasks.

Module Contents

Classes

CloudTasksQueueCreateOperator

Creates a queue in Cloud Tasks.

CloudTasksQueueUpdateOperator

Updates a queue in Cloud Tasks.

CloudTasksQueueGetOperator

Gets a queue from Cloud Tasks.

CloudTasksQueuesListOperator

Lists queues from Cloud Tasks.

CloudTasksQueueDeleteOperator

Deletes a queue from Cloud Tasks, even if it has tasks in it.

CloudTasksQueuePurgeOperator

Purges a queue by deleting all of its tasks from Cloud Tasks.

CloudTasksQueuePauseOperator

Pauses a queue in Cloud Tasks.

CloudTasksQueueResumeOperator

Resumes a queue in Cloud Tasks.

CloudTasksTaskCreateOperator

Creates a task in Cloud Tasks.

CloudTasksTaskGetOperator

Gets a task from Cloud Tasks.

CloudTasksTasksListOperator

Lists the tasks in Cloud Tasks.

CloudTasksTaskDeleteOperator

Deletes a task from Cloud Tasks.

CloudTasksTaskRunOperator

Forces to run a task in Cloud Tasks.

Attributes

MetaData

airflow.providers.google.cloud.operators.tasks.MetaData[source]
class airflow.providers.google.cloud.operators.tasks.CloudTasksQueueCreateOperator(*, location, task_queue, project_id=None, queue_name=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Creates a queue in Cloud Tasks.

See also

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

Parameters

  • location (str) -- The location name in which the queue will be created.

  • task_queue (google.cloud.tasks_v2.types.Queue) -- The task queue to create. Queue's name cannot be the same as an existing queue. If a dict is provided, it must be of the same form as the protobuf message Queue.

  • project_id (Optional[str]) -- (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.

  • queue_name (Optional[str]) -- (Optional) The queue's name. If provided, it will be used to construct the full queue path.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

Return type

google.cloud.tasks_v2.types.Queue

template_fields :Sequence[str] = ['task_queue', 'project_id', 'location', 'queue_name', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksQueueUpdateOperator(*, task_queue, project_id=None, location=None, queue_name=None, update_mask=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Updates a queue in Cloud Tasks.

See also

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

Parameters

  • task_queue (google.cloud.tasks_v2.types.Queue) -- The 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_id (Optional[str]) -- (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.

  • location (Optional[str]) -- (Optional) The location name in which the queue will be updated. If provided, it will be used to construct the full queue path.

  • queue_name (Optional[str]) -- (Optional) The queue's name. If provided, it will be used to construct the full queue path.

  • update_mask (Optional[google.protobuf.field_mask_pb2.FieldMask]) -- A 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.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

Return type

google.cloud.tasks_v2.types.Queue

template_fields :Sequence[str] = ['task_queue', 'project_id', 'location', 'queue_name', 'update_mask', 'gcp_conn_id',...[source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksQueueGetOperator(*, location, queue_name, project_id=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Gets a queue from Cloud Tasks.

See also

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

Parameters

  • location (str) -- The location name in which the queue was created.

  • queue_name (str) -- The queue's name.

  • project_id (Optional[str]) -- (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.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

Return type

google.cloud.tasks_v2.types.Queue

template_fields :Sequence[str] = ['location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksQueuesListOperator(*, location, project_id=None, results_filter=None, page_size=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Lists queues from Cloud Tasks.

See also

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

Parameters

  • location (str) -- The location name in which the queues were created.

  • project_id (Optional[str]) -- (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.

  • results_filter (Optional[str]) -- (Optional) Filter used to specify a subset of queues.

  • page_size (Optional[int]) -- (Optional) The maximum number of resources contained in the underlying API response.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

Return type

list[google.cloud.tasks_v2.types.Queue]

template_fields :Sequence[str] = ['location', 'project_id', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksQueueDeleteOperator(*, location, queue_name, project_id=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Deletes a queue from Cloud Tasks, even if it has tasks in it.

See also

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

Parameters

  • location (str) -- The location name in which the queue will be deleted.

  • queue_name (str) -- The queue's name.

  • project_id (Optional[str]) -- (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.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

template_fields :Sequence[str] = ['location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksQueuePurgeOperator(*, location, queue_name, project_id=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Purges a queue by deleting all of its tasks from Cloud Tasks.

See also

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

Parameters

  • location (str) -- The location name in which the queue will be purged.

  • queue_name (str) -- The queue's name.

  • project_id (Optional[str]) -- (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.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

Return type

list[google.cloud.tasks_v2.types.Queue]

template_fields :Sequence[str] = ['location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksQueuePauseOperator(*, location, queue_name, project_id=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Pauses a queue in Cloud Tasks.

See also

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

Parameters

  • location (str) -- The location name in which the queue will be paused.

  • queue_name (str) -- The queue's name.

  • project_id (Optional[str]) -- (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.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

Return type

list[google.cloud.tasks_v2.types.Queue]

template_fields :Sequence[str] = ['location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksQueueResumeOperator(*, location, queue_name, project_id=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Resumes a queue in Cloud Tasks.

See also

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

Parameters

  • location (str) -- The location name in which the queue will be resumed.

  • queue_name (str) -- The queue's name.

  • project_id (Optional[str]) -- (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.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

Return type

list[google.cloud.tasks_v2.types.Queue]

template_fields :Sequence[str] = ['location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksTaskCreateOperator(*, location, queue_name, task, project_id=None, task_name=None, response_view=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Creates a task in Cloud Tasks.

See also

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

Parameters

  • location (str) -- The location name in which the task will be created.

  • queue_name (str) -- The queue's name.

  • task (Union[Dict, google.cloud.tasks_v2.types.Task]) -- The task to add. If a dict is provided, it must be of the same form as the protobuf message Task.

  • project_id (Optional[str]) -- (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.

  • task_name (Optional[str]) -- (Optional) The task's name. If provided, it will be used to construct the full task path.

  • response_view (Optional[google.cloud.tasks_v2.types.Task.View]) -- (Optional) This field specifies which subset of the Task will be returned.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

Return type

google.cloud.tasks_v2.types.Task

template_fields :Sequence[str] = ['task', 'project_id', 'location', 'queue_name', 'task_name', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksTaskGetOperator(*, location, queue_name, task_name, project_id=None, response_view=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Gets a task from Cloud Tasks.

See also

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

Parameters

  • location (str) -- The location name in which the task was created.

  • queue_name (str) -- The queue's name.

  • task_name (str) -- The task's name.

  • project_id (Optional[str]) -- (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.

  • response_view (Optional[google.cloud.tasks_v2.types.Task.View]) -- (Optional) This field specifies which subset of the Task will be returned.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

Return type

google.cloud.tasks_v2.types.Task

template_fields :Sequence[str] = ['location', 'queue_name', 'task_name', 'project_id', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksTasksListOperator(*, location, queue_name, project_id=None, response_view=None, page_size=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Lists the tasks in Cloud Tasks.

See also

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

Parameters

  • location (str) -- The location name in which the tasks were created.

  • queue_name (str) -- The queue's name.

  • project_id (Optional[str]) -- (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.

  • response_view (Optional[google.cloud.tasks_v2.types.Task.View]) -- (Optional) This field specifies which subset of the Task will be returned.

  • page_size (Optional[int]) -- (Optional) The maximum number of resources contained in the underlying API response.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

Return type

list[google.cloud.tasks_v2.types.Task]

template_fields :Sequence[str] = ['location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksTaskDeleteOperator(*, location, queue_name, task_name, project_id=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Deletes a task from Cloud Tasks.

See also

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

Parameters

  • location (str) -- The location name in which the task will be deleted.

  • queue_name (str) -- The queue's name.

  • task_name (str) -- The task's name.

  • project_id (Optional[str]) -- (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.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

template_fields :Sequence[str] = ['location', 'queue_name', 'task_name', 'project_id', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to 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.tasks.CloudTasksTaskRunOperator(*, location, queue_name, task_name, project_id=None, response_view=None, retry=None, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Forces to run a task in Cloud Tasks.

See also

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

Parameters

  • location (str) -- The location name in which the task was created.

  • queue_name (str) -- The queue's name.

  • task_name (str) -- The task's name.

  • project_id (Optional[str]) -- (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.

  • response_view (Optional[google.cloud.tasks_v2.types.Task.View]) -- (Optional) This field specifies which subset of the Task will be returned.

  • retry (Optional[google.api_core.retry.Retry]) -- (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) -- (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.

  • metadata (MetaData) -- (Optional) Additional metadata that is provided to the method.

  • gcp_conn_id (str) -- (Optional) The connection ID used to connect to Google Cloud.

  • impersonation_chain (Optional[Union[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).

Return type

google.cloud.tasks_v2.types.Task

template_fields :Sequence[str] = ['location', 'queue_name', 'task_name', 'project_id', 'gcp_conn_id', 'impersonation_chain'][source]
execute(self, context)[source]

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?