tasks

Creates, updates, deletes, gets or lists a tasks resource.

Overview

Name	tasks
Type	Resource
Id	google.batch.tasks

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01".
status	object	Task Status. (id: TaskStatus)

list

Successful response

Name	Datatype	Description
name	string	Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01".
status	object	Task Status. (id: TaskStatus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, jobsId, taskGroupsId, tasksId		Return a single Task.
list	select	projectsId, locationsId, jobsId, taskGroupsId	filter, pageSize, pageToken	List Tasks associated with a job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
jobsId	string
locationsId	string
projectsId	string
taskGroupsId	string
tasksId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Return a single Task.

SELECT
name,
status
FROM google.batch.tasks
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND jobsId = '{{ jobsId }}' -- required
AND taskGroupsId = '{{ taskGroupsId }}' -- required
AND tasksId = '{{ tasksId }}' -- required;

list

List Tasks associated with a job.

SELECT
name,
status
FROM google.batch.tasks
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND jobsId = '{{ jobsId }}' -- required
AND taskGroupsId = '{{ taskGroupsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';