airflow.providers.google.cloud.hooks.workflows

Module Contents

Classes

WorkflowsHook

Hook for Google GCP APIs.
class airflow.providers.google.cloud.hooks.workflows.WorkflowsHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

Hook for Google GCP APIs.

All the methods in the hook where project_id is used must be called with keyword arguments rather than positional.

get_workflows_client()[source]

Return WorkflowsClient object.

get_executions_client()[source]

Return ExecutionsClient object.

create_workflow(workflow, workflow_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Create a new workflow.

If a workflow with the specified name already exists in the specified project and location, the long running operation will return [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.

Parameters

  • workflow (dict) – Required. Workflow to be created.

  • workflow_id (str) – Required. The ID of the workflow to be created.

  • project_id (str) – Required. The ID of the Google Cloud project the cluster belongs to.

  • location (str) – Required. The GCP region in which to handle the request.

  • 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 not be retried.

  • 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.

get_workflow(workflow_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Get details of a single Workflow.

Parameters

  • workflow_id (str) – Required. The ID of the workflow to be created.

  • project_id (str) – Required. The ID of the Google Cloud project the cluster belongs to.

  • location (str) – Required. The GCP region in which to handle the request.

  • 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 not be retried.

  • 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.

update_workflow(workflow, update_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]

Update an existing workflow.

Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.

Parameters

  • workflow (dict | google.cloud.workflows_v1beta.Workflow) – Required. Workflow to be created.

  • update_mask (google.protobuf.field_mask_pb2.FieldMask | None) – List of fields to be updated. If not present, the entire workflow will be updated.

  • 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 not be retried.

  • 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.

delete_workflow(workflow_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Delete a workflow with the specified name and all running executions of the workflow.

Parameters

  • workflow_id (str) – Required. The ID of the workflow to be created.

  • project_id (str) – Required. The ID of the Google Cloud project the cluster belongs to.

  • location (str) – Required. The GCP region in which to handle the request.

  • 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 not be retried.

  • 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.

list_workflows(location, project_id=PROVIDE_PROJECT_ID, filter_=None, order_by=None, retry=DEFAULT, timeout=None, metadata=())[source]

List Workflows in a given project and location; the default order is not specified.

Parameters

  • filter – Filter to restrict results to specific workflows.

  • order_by (str | None) – Comma-separated list of fields that specifies the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a “desc” suffix. If not specified, the results will be returned in an unspecified order.

  • project_id (str) – Required. The ID of the Google Cloud project the cluster belongs to.

  • location (str) – Required. The GCP region in which to handle the request.

  • 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 not be retried.

  • 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.

create_execution(workflow_id, location, execution, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Create a new execution using the latest revision of the given workflow.

Parameters

  • execution (dict) – Required. Input parameters of the execution represented as a dictionary.

  • workflow_id (str) – Required. The ID of the workflow.

  • project_id (str) – Required. The ID of the Google Cloud project the cluster belongs to.

  • location (str) – Required. The GCP region in which to handle the request.

  • 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 not be retried.

  • 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.

get_execution(workflow_id, execution_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Return an execution for the given workflow_id and execution_id.

Parameters

  • workflow_id (str) – Required. The ID of the workflow.

  • execution_id (str) – Required. The ID of the execution.

  • project_id (str) – Required. The ID of the Google Cloud project the cluster belongs to.

  • location (str) – Required. The GCP region in which to handle the request.

  • 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 not be retried.

  • 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.

cancel_execution(workflow_id, execution_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Cancel an execution using the given workflow_id and execution_id.

Parameters

  • workflow_id (str) – Required. The ID of the workflow.

  • execution_id (str) – Required. The ID of the execution.

  • project_id (str) – Required. The ID of the Google Cloud project the cluster belongs to.

  • location (str) – Required. The GCP region in which to handle the request.

  • 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 not be retried.

  • 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.

list_executions(workflow_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Return a list of executions which belong to the workflow with the given name.

The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).

Parameters

  • workflow_id (str) – Required. The ID of the workflow to be created.

  • project_id (str) – Required. The ID of the Google Cloud project the cluster belongs to.

  • location (str) – Required. The GCP region in which to handle the request.

  • 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 not be retried.

  • 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.

Was this entry helpful?