jobs

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

Overview

Name	jobs
Type	Resource
Id	google.datapipelines.jobs

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	Output only. The internal ID for the job.
name	string	Required. The fully qualified resource name for the job.
createTime	string (google-datetime)	Output only. The time of job creation.
dataflowJobDetails	object	All the details that are specific to a Dataflow job. (id: GoogleCloudDatapipelinesV1DataflowJobDetails)
endTime	string (google-datetime)	Output only. The time of job termination. This is absent if the job is still running.
state	string	The current state of the job. (STATE_UNSPECIFIED, STATE_PENDING, STATE_RUNNING, STATE_DONE, STATE_FAILED, STATE_CANCELLED)
status	object	Status capturing any error code or message related to job creation or execution. (id: GoogleRpcStatus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	projectsId, locationsId, pipelinesId	pageToken, pageSize	Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the caller doesn't have permission to access it.

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
locationsId	string
pipelinesId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

list

Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the caller doesn't have permission to access it.

SELECT
id,
name,
createTime,
dataflowJobDetails,
endTime,
state,
status
FROM google.datapipelines.jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pipelinesId = '{{ pipelinesId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;