Method: projects.locations.dataScans.get

Gets a DataScan resource.

HTTP request

GET https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/dataScans/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the dataScan: projects/{project}/locations/{locationId}/dataScans/{dataScanId} where project refers to a projectId or project_number and locationId refers to a GCP region.

Authorization requires the following IAM permission on the specified resource name:

  • iam.permissions.none

Query parameters

Parameters
view

enum (DataScanView)

Optional. Select the DataScan view to return. Defaults to BASIC.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of DataScan.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DataScanView

DataScan view options.

Enums
DATA_SCAN_VIEW_UNSPECIFIED The API will default to the BASIC view.
BASIC Basic view that does not include spec and result.
FULL Include everything.