REST Resource: projects.locations.dataScans.jobs

Resource: DataScanJob

A DataScanJob represents an instance of DataScan execution.

JSON representation 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "state": enum (State),
  "message": string,
  "type": enum (DataScanType),

  // Union field spec can be only one of the following:
  "dataQualitySpec": {
    object (DataQualitySpec)
  },
  "dataProfileSpec": {
    object (DataProfileSpec)
  },
  "dataDiscoverySpec": {
    object (DataDiscoverySpec)
  }
  // End of list of possible types for union field spec.

  // Union field result can be only one of the following:
  "dataQualityResult": {
    object (DataQualityResult)
  },
  "dataProfileResult": {
    object (DataProfileResult)
  },
  "dataDiscoveryResult": {
    object (DataDiscoveryResult)
  }
  // End of list of possible types for union field result.
}
Fields
name

string

Output only. 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 GCP 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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
startTime

string (Timestamp format)

Output only. The time when the DataScanJob was started.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Output only. The time when the DataScanJob ended.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. Execution state for the DataScanJob.
message

string

Output only. Additional information about the current state.
type

enum (DataScanType)

Output only. The type of the parent DataScan.
Union field 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.
Union field 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

generateDataQualityRules

 Generates recommended data quality rules based on the results of a data profiling scan.

get

 Gets a DataScanJob resource.

list

 Lists DataScanJobs under the given DataScan.