Workflows API Connector Overview

The Workflows connector defines the built-infunctions that can be used to access other Google Cloud products within aworkflow.

This page provides an overview of the individual connector.There is no need to import or load connector libraries in a workflow—connectorswork out of the box when used in a call step.

Workflows API

Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.To learn more, see theWorkflows API documentation.

Workflows connector sample

YAML

# This workflow demonstrates how to use the Workflows connector:# Create, get, and then delete a workflow# Expected output: "SUCCESS"-init:assign:-project:${sys.get_env("GOOGLE_CLOUD_PROJECT_ID")}-location:"us-central1"-workflow:"example-workflow"-create_workflow:call:googleapis.workflows.v1.projects.locations.workflows.createargs:parent:${"projects/" + project + "/locations/" + location}workflowId:${workflow}body:name:${"projects/" + project + "/locations/" + location + "/workflows/" + workflow}description:"AnexampleworkflowtocreateanddeleteusingtheWorkflowsconnector"sourceContents:"-step:\nnext:end"-get_workflow:call:googleapis.workflows.v1.projects.locations.workflows.getargs:name:${"projects/" + project + "/locations/" + location + "/workflows/" + workflow}-delete_workflow:call:googleapis.workflows.v1.projects.locations.workflows.deleteargs:name:${"projects/" + project + "/locations/" + location + "/workflows/" + workflow}-the_end:return:"SUCCESS"

JSON

[{"init":{"assign":[{"project":"${sys.get_env(\"GOOGLE_CLOUD_PROJECT_ID\")}"},{"location":"us-central1"},{"workflow":"example-workflow"}]}},{"create_workflow":{"call":"googleapis.workflows.v1.projects.locations.workflows.create","args":{"parent":"${\"projects/\" + project + \"/locations/\" + location}","workflowId":"${workflow}","body":{"name":"${\"projects/\" + project + \"/locations/\" + location + \"/workflows/\" + workflow}","description":"An example workflow to create and delete using the Workflows connector","sourceContents":"- step:\n    next: end"}}}},{"get_workflow":{"call":"googleapis.workflows.v1.projects.locations.workflows.get","args":{"name":"${\"projects/\" + project + \"/locations/\" + location + \"/workflows/\" + workflow}"}}},{"delete_workflow":{"call":"googleapis.workflows.v1.projects.locations.workflows.delete","args":{"name":"${\"projects/\" + project + \"/locations/\" + location + \"/workflows/\" + workflow}"}}},{"the_end":{"return":"SUCCESS"}}]

Module: googleapis.workflows.v1.projects.locations

Functions
getGets information about a location.
listLists information about the supported locations for this service.

Module: googleapis.workflows.v1.projects.locations.operations

Functions
deleteDeletes a long-running operation. This method indicates that the clientis no longer interested in the operation result. It does not cancel theoperation. If the server doesn't support this method, it returnsgoogle.rpc.Code.UNIMPLEMENTED.
getGets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by theAPI service.
listLists operations that match the specified filter in the request. If theserver doesn't support this method, it returnsUNIMPLEMENTED. NOTE:thename binding allows API services to override the binding to usedifferent resource name schemes, such asusers/*/operations. Tooverride the binding, API services can add a binding such as"/v1/{name=users/*}/operations" to their service configuration. Forbackwards compatibility, the default name includes the operationscollection id, however overriding users must ensure the name binding isthe parent resource, without the operations collection id.

Module: googleapis.workflows.v1.projects.locations.workflows

Functions
createCreates a new workflow. If a workflow with the specified name alreadyexists in the specified project and location, the long running operationwill return ALREADY_EXISTS error.
deleteDeletes a workflow with the specified name. This method also cancels anddeletes all running executions of the workflow.
getGets details of a single Workflow.
listLists Workflows in a given project and location. The default order isnot specified.
patchUpdates an existing workflow. Running this method has no impact onalready running executions of the workflow. A new revision of theworkflow may be created as a result of a successful update operation. Inthat case, such revision will be used in new workflow executions.

Module: googleapis.workflows.v1beta.projects.locations

Functions
getGets information about a location.
listLists information about the supported locations for this service.

Module: googleapis.workflows.v1beta.projects.locations.operations

Functions
deleteDeletes a long-running operation. This method indicates that the clientis no longer interested in the operation result. It does not cancel theoperation. If the server doesn't support this method, it returnsgoogle.rpc.Code.UNIMPLEMENTED.
getGets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by theAPI service.
listLists operations that match the specified filter in the request. If theserver doesn't support this method, it returnsUNIMPLEMENTED. NOTE:thename binding allows API services to override the binding to usedifferent resource name schemes, such asusers/*/operations. Tooverride the binding, API services can add a binding such as"/v1/{name=users/*}/operations" to their service configuration. Forbackwards compatibility, the default name includes the operationscollection id, however overriding users must ensure the name binding isthe parent resource, without the operations collection id.

Module: googleapis.workflows.v1beta.projects.locations.workflows

Functions
createCreates a new workflow. If a workflow with the specified name alreadyexists in the specified project and location, the long running operationwill return ALREADY_EXISTS error.
deleteDeletes a workflow with the specified name. This method also cancels anddeletes all running executions of the workflow.
getGets details of a single Workflow.
listLists Workflows in a given project and location. The default order isnot specified.
patchUpdates an existing workflow. Running this method has no impact onalready running executions of the workflow. A new revision of theworkflow may be created as a result of a successful update operation. Inthat case, such revision will be used in new workflow executions.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.