Note: The following fields are mutually exclusive: data_discovery_result, data_quality_result, data_profile_result. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: data_discovery_spec, data_quality_spec, data_profile_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: data_profile_result, data_quality_result, data_discovery_result. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: data_profile_spec, data_quality_spec, data_discovery_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: data_quality_result, data_profile_result, data_discovery_result. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: data_quality_spec, data_profile_spec, data_discovery_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.
(::String) — Output only. Additional information about the current state.
#name
defname()->::String
Returns
(::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 GCP region.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataScanJob (v2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/ruby/docs/reference/google-cloud-dataplex-v1/latest/Google-Cloud-Dataplex-V1-DataScanJob)\n- [2.4.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.4.1/Google-Cloud-Dataplex-V1-DataScanJob)\n- [2.3.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.3.1/Google-Cloud-Dataplex-V1-DataScanJob)\n- [2.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.2.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [2.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.1.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [2.0.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.0.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [1.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.4.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [1.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.3.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [1.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.2.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [1.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.1.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [1.0.1](/ruby/docs/reference/google-cloud-dataplex-v1/1.0.1/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.23.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.23.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.22.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.22.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.21.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.21.1/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.20.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.20.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.19.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.19.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.18.2](/ruby/docs/reference/google-cloud-dataplex-v1/0.18.2/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.17.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.17.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.16.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.16.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.15.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.15.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.14.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.14.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.13.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.12.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.12.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.11.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.10.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.10.1/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.9.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.9.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.8.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.8.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.7.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.6.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.6.1/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.5.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.5.1/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.4.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.3.0/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.2.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.2.1/Google-Cloud-Dataplex-V1-DataScanJob)\n- [0.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.1.0/Google-Cloud-Dataplex-V1-DataScanJob) \nReference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataScanJob.\n\nA DataScanJob represents an instance of DataScan execution. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time when the DataScanJob was created.\n\n### #data_discovery_result\n\n def data_discovery_result() -\u003e ::Google::Cloud::Dataplex::V1::DataDiscoveryResult\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataDiscoveryResult](./Google-Cloud-Dataplex-V1-DataDiscoveryResult)) --- Output only. The result of a data discovery scan.\n\n\n Note: The following fields are mutually exclusive: `data_discovery_result`, `data_quality_result`, `data_profile_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #data_discovery_spec\n\n def data_discovery_spec() -\u003e ::Google::Cloud::Dataplex::V1::DataDiscoverySpec\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataDiscoverySpec](./Google-Cloud-Dataplex-V1-DataDiscoverySpec)) --- Output only. Settings for a data discovery scan.\n\n\n Note: The following fields are mutually exclusive: `data_discovery_spec`, `data_quality_spec`, `data_profile_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #data_profile_result\n\n def data_profile_result() -\u003e ::Google::Cloud::Dataplex::V1::DataProfileResult\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataProfileResult](./Google-Cloud-Dataplex-V1-DataProfileResult)) --- Output only. The result of a data profile scan.\n\n\n Note: The following fields are mutually exclusive: `data_profile_result`, `data_quality_result`, `data_discovery_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #data_profile_spec\n\n def data_profile_spec() -\u003e ::Google::Cloud::Dataplex::V1::DataProfileSpec\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataProfileSpec](./Google-Cloud-Dataplex-V1-DataProfileSpec)) --- Output only. Settings for a data profile scan.\n\n\n Note: The following fields are mutually exclusive: `data_profile_spec`, `data_quality_spec`, `data_discovery_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #data_quality_result\n\n def data_quality_result() -\u003e ::Google::Cloud::Dataplex::V1::DataQualityResult\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataQualityResult](./Google-Cloud-Dataplex-V1-DataQualityResult)) --- Output only. The result of a data quality scan.\n\n\n Note: The following fields are mutually exclusive: `data_quality_result`, `data_profile_result`, `data_discovery_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #data_quality_spec\n\n def data_quality_spec() -\u003e ::Google::Cloud::Dataplex::V1::DataQualitySpec\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataQualitySpec](./Google-Cloud-Dataplex-V1-DataQualitySpec)) --- Output only. Settings for a data quality scan.\n\n\n Note: The following fields are mutually exclusive: `data_quality_spec`, `data_profile_spec`, `data_discovery_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #end_time\n\n def end_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time when the DataScanJob ended.\n\n### #message\n\n def message() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. Additional information about the current state.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::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 GCP region.\n\n### #start_time\n\n def start_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time when the DataScanJob was started.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::Dataplex::V1::DataScanJob::State\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataScanJob::State](./Google-Cloud-Dataplex-V1-DataScanJob-State)) --- Output only. Execution state for the DataScanJob.\n\n### #type\n\n def type() -\u003e ::Google::Cloud::Dataplex::V1::DataScanType\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataScanType](./Google-Cloud-Dataplex-V1-DataScanType)) --- Output only. The type of the parent DataScan.\n\n### #uid\n\n def uid() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. System generated globally unique ID for the DataScanJob."]]
