WorkflowsUpdateWorkflowOperator

Google

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

View on GitHub

Last Updated: Jan. 28, 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

workflow_idRequiredstrRequired. The ID of the workflow to be updated.
locationRequiredstrRequired. The GCP region in which to handle the request.
project_idstrRequired. The ID of the Google Cloud project the cluster belongs to.
update_maskFieldMaskList of fields to be updated. If not present, the entire workflow will be updated.
retrygoogle.api_core.retry.RetryA retry object used to retry requests. If None is specified, requests will not be retried.
timeoutfloatThe 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]]Additional metadata that is provided to the method.

Documentation

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

See also

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

Was this page helpful?