Resource: DataScanJob
A DataScanJob represents an instance of DataScan execution.
JSON representation |
---|
{ "name" : string , "uid" : string , "createTime" : string , "startTime" : string , "endTime" : string , "state" : enum ( |
name
string
Output only. Identifier. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{locationId}/dataScans/{datascanId}/jobs/{jobId}
, where project
refers to a projectId
or project_number
and locationId
refers to a Google Cloud region.
uid
string
Output only. System generated globally unique ID for the DataScanJob.
createTime
string (
Timestamp
format)
Output only. The time when the DataScanJob was created.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
startTime
string (
Timestamp
format)
Output only. The time when the DataScanJob was started.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
endTime
string (
Timestamp
format)
Output only. The time when the DataScanJob ended.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
state
enum (
State
)
Output only. Execution state for the DataScanJob.
type
enum (
DataScanType
)
Output only. The type of the parent DataScan.
spec
. Data scan related setting. spec
can be only one of the following:dataQualitySpec
object (
DataQualitySpec
)
Output only. Settings for a data quality scan.
dataProfileSpec
object (
DataProfileSpec
)
Output only. Settings for a data profile scan.
dataDiscoverySpec
object (
DataDiscoverySpec
)
Output only. Settings for a data discovery scan.
result
. The result of the data scan. result
can be only one of the following:dataQualityResult
object (
DataQualityResult
)
Output only. The result of a data quality scan.
dataProfileResult
object (
DataProfileResult
)
Output only. The result of a data profile scan.
dataDiscoveryResult
object (
DataDiscoveryResult
)
Output only. The result of a data discovery scan.
State
Execution state for the DataScanJob.
Enums | |
---|---|
STATE_UNSPECIFIED
|
The DataScanJob state is unspecified. |
RUNNING
|
The DataScanJob is running. |
CANCELING
|
The DataScanJob is canceling. |
CANCELLED
|
The DataScanJob cancellation was successful. |
SUCCEEDED
|
The DataScanJob completed successfully. |
FAILED
|
The DataScanJob is no longer running due to an error. |
PENDING
|
The DataScanJob has been created but not started to run yet. |
Methods |
|
---|---|
|
Generates recommended data quality rules based on the results of a data profiling scan. |
|
Gets a DataScanJob resource. |
|
Lists DataScanJobs under the given DataScan. |