jobs

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

Overview

Name	jobs
Type	Resource
Id	google.dataplex.jobs

Fields

The following fields are returned by SELECT queries:

projects_locations_lakes_tasks_jobs_get

Successful response

Name	Datatype	Description
name	string	Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.
endTime	string (google-datetime)	Output only. The time when the job ended.
executionSpec	object	Output only. Spec related to how a task is executed. (id: GoogleCloudDataplexV1TaskExecutionSpec)
labels	object	Output only. User-defined labels for the task.
message	string	Output only. Additional information about the current state.
retryCount	integer (uint32)	Output only. The number of times the job has been retried (excluding the initial attempt).
service	string	Output only. The underlying service running a job.
serviceJob	string	Output only. The full resource name for the job run under a particular service.
startTime	string (google-datetime)	Output only. The time when the job was started.
state	string	Output only. Execution state for the job.
trigger	string	Output only. Job execution trigger.
uid	string	Output only. System generated globally unique ID for the job.

projects_locations_lakes_tasks_jobs_list

Successful response

Name	Datatype	Description
name	string	Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.
endTime	string (google-datetime)	Output only. The time when the job ended.
executionSpec	object	Output only. Spec related to how a task is executed. (id: GoogleCloudDataplexV1TaskExecutionSpec)
labels	object	Output only. User-defined labels for the task.
message	string	Output only. Additional information about the current state.
retryCount	integer (uint32)	Output only. The number of times the job has been retried (excluding the initial attempt).
service	string	Output only. The underlying service running a job.
serviceJob	string	Output only. The full resource name for the job run under a particular service.
startTime	string (google-datetime)	Output only. The time when the job was started.
state	string	Output only. Execution state for the job.
trigger	string	Output only. Job execution trigger.
uid	string	Output only. System generated globally unique ID for the job.

projects_locations_data_scans_jobs_get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a Google Cloud region.
createTime	string (google-datetime)	Output only. The time when the DataScanJob was created.
dataDiscoveryResult	object	Output only. The result of a data discovery scan. (id: GoogleCloudDataplexV1DataDiscoveryResult)
dataDiscoverySpec	object	Output only. Settings for a data discovery scan. (id: GoogleCloudDataplexV1DataDiscoverySpec)
dataProfileResult	object	Output only. The result of a data profile scan. (id: GoogleCloudDataplexV1DataProfileResult)
dataProfileSpec	object	Output only. Settings for a data profile scan. (id: GoogleCloudDataplexV1DataProfileSpec)
dataQualityResult	object	Output only. The result of a data quality scan. (id: GoogleCloudDataplexV1DataQualityResult)
dataQualitySpec	object	Output only. Settings for a data quality scan. (id: GoogleCloudDataplexV1DataQualitySpec)
endTime	string (google-datetime)	Output only. The time when the DataScanJob ended.
message	string	Output only. Additional information about the current state.
startTime	string (google-datetime)	Output only. The time when the DataScanJob was started.
state	string	Output only. Execution state for the DataScanJob.
type	string	Output only. The type of the parent DataScan.
uid	string	Output only. System generated globally unique ID for the DataScanJob.

projects_locations_data_scans_jobs_list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a Google Cloud region.
createTime	string (google-datetime)	Output only. The time when the DataScanJob was created.
dataDiscoveryResult	object	Output only. The result of a data discovery scan. (id: GoogleCloudDataplexV1DataDiscoveryResult)
dataDiscoverySpec	object	Output only. Settings for a data discovery scan. (id: GoogleCloudDataplexV1DataDiscoverySpec)
dataProfileResult	object	Output only. The result of a data profile scan. (id: GoogleCloudDataplexV1DataProfileResult)
dataProfileSpec	object	Output only. Settings for a data profile scan. (id: GoogleCloudDataplexV1DataProfileSpec)
dataQualityResult	object	Output only. The result of a data quality scan. (id: GoogleCloudDataplexV1DataQualityResult)
dataQualitySpec	object	Output only. Settings for a data quality scan. (id: GoogleCloudDataplexV1DataQualitySpec)
endTime	string (google-datetime)	Output only. The time when the DataScanJob ended.
message	string	Output only. Additional information about the current state.
startTime	string (google-datetime)	Output only. The time when the DataScanJob was started.
state	string	Output only. Execution state for the DataScanJob.
type	string	Output only. The type of the parent DataScan.
uid	string	Output only. System generated globally unique ID for the DataScanJob.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_lakes_tasks_jobs_get	select	projectsId, locationsId, lakesId, tasksId, jobsId		Get job resource.
projects_locations_lakes_tasks_jobs_list	select	projectsId, locationsId, lakesId, tasksId	pageSize, pageToken	Lists Jobs under the given task.
projects_locations_data_scans_jobs_get	select	projectsId, locationsId, dataScansId, jobsId	view	Gets a DataScanJob resource.
projects_locations_data_scans_jobs_list	select	projectsId, locationsId, dataScansId	pageSize, pageToken, filter	Lists DataScanJobs under the given DataScan.
projects_locations_lakes_tasks_jobs_cancel	exec	projectsId, locationsId, lakesId, tasksId, jobsId		Cancel jobs running for the task resource.
projects_locations_data_scans_jobs_generate_data_quality_rules	exec	projectsId, locationsId, dataScansId, jobsId		Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.

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
dataScansId	string
jobsId	string
lakesId	string
locationsId	string
projectsId	string
tasksId	string
filter	string
pageSize	integer (int32)
pageToken	string
view	string

SELECT examples

projects_locations_lakes_tasks_jobs_get

Get job resource.

SELECT
name,
endTime,
executionSpec,
labels,
message,
retryCount,
service,
serviceJob,
startTime,
state,
trigger,
uid
FROM google.dataplex.jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND lakesId = '{{ lakesId }}' -- required
AND tasksId = '{{ tasksId }}' -- required
AND jobsId = '{{ jobsId }}' -- required;

projects_locations_lakes_tasks_jobs_list

Lists Jobs under the given task.

SELECT
name,
endTime,
executionSpec,
labels,
message,
retryCount,
service,
serviceJob,
startTime,
state,
trigger,
uid
FROM google.dataplex.jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND lakesId = '{{ lakesId }}' -- required
AND tasksId = '{{ tasksId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

projects_locations_data_scans_jobs_get

Gets a DataScanJob resource.

SELECT
name,
createTime,
dataDiscoveryResult,
dataDiscoverySpec,
dataProfileResult,
dataProfileSpec,
dataQualityResult,
dataQualitySpec,
endTime,
message,
startTime,
state,
type,
uid
FROM google.dataplex.jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataScansId = '{{ dataScansId }}' -- required
AND jobsId = '{{ jobsId }}' -- required
AND view = '{{ view }}';

projects_locations_data_scans_jobs_list

Lists DataScanJobs under the given DataScan.

SELECT
name,
createTime,
dataDiscoveryResult,
dataDiscoverySpec,
dataProfileResult,
dataProfileSpec,
dataQualityResult,
dataQualitySpec,
endTime,
message,
startTime,
state,
type,
uid
FROM google.dataplex.jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataScansId = '{{ dataScansId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

Lifecycle Methods

projects_locations_lakes_tasks_jobs_cancel

Cancel jobs running for the task resource.

EXEC google.dataplex.jobs.projects_locations_lakes_tasks_jobs_cancel 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@lakesId='{{ lakesId }}' --required, 
@tasksId='{{ tasksId }}' --required, 
@jobsId='{{ jobsId }}' --required;

projects_locations_data_scans_jobs_generate_data_quality_rules

Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.

EXEC google.dataplex.jobs.projects_locations_data_scans_jobs_generate_data_quality_rules 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataScansId='{{ dataScansId }}' --required, 
@jobsId='{{ jobsId }}' --required;