Send feedback
Batch API Connector Overview
Stay organized with collections
Save and categorize content based on your preferences.
The Workflows connector defines the built-in
functions that can be used to access other Google Cloud products within a
workflow.
This page provides an overview of the individual connector.
There is no need to import or load connector libraries in a workflow—connectors
work 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 the Batch API documentation .
Batch connector sample
Module: googleapis.batch.v1.projects.locations
Functions
get
Gets information about a location.
list
Lists information about the supported locations for this service.
Module: googleapis.batch.v1.projects.locations.jobs
Functions
create
Create a Job.
delete
Delete a Job.
get
Get a Job specified by its resource name.
list
List all Jobs for a project within a region.
Module: googleapis.batch.v1.projects.locations.jobs.taskGroups.tasks
Functions
get
Return a single Task.
list
List Tasks associated with a job.
Module: googleapis.batch.v1.projects.locations.operations
Functions
get
Gets the latest state of a long-running operation. Clients can use this
method to poll the operation result at intervals as recommended by the
API service.
list
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-25 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[],[],null,["# Batch API Connector Overview\n\nThe Workflows connector defines the built-in\nfunctions that can be used to access other Google Cloud products within a\nworkflow.\n\nThis page provides an overview of the individual connector.\nThere is no need to import or load connector libraries in a workflow---connectors\nwork out of the box when used in a call step.\n\nBatch API\n---------\n\nAn API to manage the running of batch jobs on Google Cloud Platform.\nTo learn more, see the [Batch API documentation](https://cloud.google.com/batch/).\n\nBatch connector sample\n----------------------\n\n### YAML\n\n # This workflow demonstrates how to use the Batch connector.\n # This workflow sends a List request to Batch connector.\n main:\n steps:\n - init:\n assign:\n - project: ${sys.get_env(\"GOOGLE_CLOUD_PROJECT_ID\")}\n - location: ${sys.get_env(\"GOOGLE_CLOUD_LOCATION\")}\n - jobId: \"example-job\"\n - create_job:\n call: googleapis.batch.v1.projects.locations.jobs.create\n args:\n parent: ${\"projects/\" + project + \"/locations/\" + location}\n jobId: ${jobId}\n body:\n priority: 99\n taskGroups:\n taskSpec:\n runnables:\n script:\n text: \"echo Hello World!\"\n computeResource:\n cpuMilli: 2000\n memoryMib: 16\n taskCount: 1\n - delete_job:\n call: googleapis.batch.v1.projects.locations.jobs.delete\n args:\n name: ${\"projects/\" + project + \"/locations/\" + location + \"/jobs/\" + jobId}\n\n### JSON\n\n {\n \"main\": {\n \"steps\": [\n {\n \"init\": {\n \"assign\": [\n {\n \"project\": \"${sys.get_env(\\\"GOOGLE_CLOUD_PROJECT_ID\\\")}\"\n },\n {\n \"location\": \"${sys.get_env(\\\"GOOGLE_CLOUD_LOCATION\\\")}\"\n },\n {\n \"jobId\": \"example-job\"\n }\n ]\n }\n },\n {\n \"create_job\": {\n \"call\": \"googleapis.batch.v1.projects.locations.jobs.create\",\n \"args\": {\n \"parent\": \"${\\\"projects/\\\" + project + \\\"/locations/\\\" + location}\",\n \"jobId\": \"${jobId}\",\n \"body\": {\n \"priority\": 99,\n \"taskGroups\": {\n \"taskSpec\": {\n \"runnables\": {\n \"script\": {\n \"text\": \"echo Hello World!\"\n }\n },\n \"computeResource\": {\n \"cpuMilli\": 2000,\n \"memoryMib\": 16\n }\n },\n \"taskCount\": 1\n }\n }\n }\n }\n },\n {\n \"delete_job\": {\n \"call\": \"googleapis.batch.v1.projects.locations.jobs.delete\",\n \"args\": {\n \"name\": \"${\\\"projects/\\\" + project + \\\"/locations/\\\" + location + \\\"/jobs/\\\" + jobId}\"\n }\n }\n }\n ]\n }\n }\n\nModule: googleapis.batch.v1.projects.locations\n----------------------------------------------\n\nModule: googleapis.batch.v1.projects.locations.jobs\n---------------------------------------------------\n\nModule: googleapis.batch.v1.projects.locations.jobs.taskGroups.tasks\n--------------------------------------------------------------------\n\nModule: googleapis.batch.v1.projects.locations.operations\n---------------------------------------------------------"]]