get method
Gets a DataScanJob resource.
Request parameters:
name
- Required. The resource name of the DataScanJob:
projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id}
where project refers to a project_id or project_number and location_id
refers to a GCP region.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/dataScans/\[^/\]+/jobs/\[^/\]+$
.
view
- Optional. Select the DataScanJob view to return. Defaults to
BASIC.
Possible string values are:
- "DATA_SCAN_JOB_VIEW_UNSPECIFIED" : The API will default to the BASIC view.
- "BASIC" : Basic view that does not include spec and result.
- "FULL" : Include everything.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudDataplexV1DataScanJob.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<GoogleCloudDataplexV1DataScanJob> get(
core.String name, {
core.String? view,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (view != null) 'view': [view],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudDataplexV1DataScanJob.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}