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

Batch API

An API to manage the running of batch jobs on Google Cloud Platform.To learn more, see theBatch API documentation.

Batch connector sample

YAML

# This workflow demonstrates how to use the Batch connector.# This workflow sends a List request to Batch connector.main:steps:-init:assign:-project:${sys.get_env("GOOGLE_CLOUD_PROJECT_ID")}-location:${sys.get_env("GOOGLE_CLOUD_LOCATION")}-jobId:"example-job"-create_job:call:googleapis.batch.v1.projects.locations.jobs.createargs:parent:${"projects/" + project + "/locations/" + location}jobId:${jobId}body:priority:99taskGroups:taskSpec:runnables:script:text:"echoHelloWorld!"computeResource:cpuMilli:2000memoryMib:16taskCount:1-delete_job:call:googleapis.batch.v1.projects.locations.jobs.deleteargs:name:${"projects/" + project + "/locations/" + location + "/jobs/" + jobId}

JSON

{"main":{"steps":[{"init":{"assign":[{"project":"${sys.get_env(\"GOOGLE_CLOUD_PROJECT_ID\")}"},{"location":"${sys.get_env(\"GOOGLE_CLOUD_LOCATION\")}"},{"jobId":"example-job"}]}},{"create_job":{"call":"googleapis.batch.v1.projects.locations.jobs.create","args":{"parent":"${\"projects/\" + project + \"/locations/\" + location}","jobId":"${jobId}","body":{"priority":99,"taskGroups":{"taskSpec":{"runnables":{"script":{"text":"echo Hello World!"}},"computeResource":{"cpuMilli":2000,"memoryMib":16}},"taskCount":1}}}}},{"delete_job":{"call":"googleapis.batch.v1.projects.locations.jobs.delete","args":{"name":"${\"projects/\" + project + \"/locations/\" + location + \"/jobs/\" + jobId}"}}}]}}

Module: googleapis.batch.v1.projects.locations

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

Module: googleapis.batch.v1.projects.locations.jobs

Functions
createCreate a Job.
deleteDelete a Job.
getGet a Job specified by its resource name.
listList all Jobs for a project within a region.

Module: googleapis.batch.v1.projects.locations.jobs.taskGroups.tasks

Functions
getReturn a single Task.
listList Tasks associated with a job.

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

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

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.