Post v1+parentdatascans — dataplex

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1372300401.5 KB

projects

Creates a DataScan resource.

post/v1/{+parent}/dataScans

Path parameters

parentstring required

Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a Google Cloud region.

Query parameters

dataScanIdstring

Optional. DataScan identifier. If not provided, a unique ID will be generated with the prefix "data-scan-". Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.

validateOnlyboolean

Optional. Only validate the request, but do not perform mutations. The default is false.

Request body

displayNamestring

Optional. User friendly display name. Must be between 1-256 characters.

labelsobject

Optional. User-defined labels for the scan.

uidstring

Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.

descriptionstring

Optional. Description of the scan. Must be between 1-1024 characters.

namestring

Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a Google Cloud region.

createTimestring google-datetime

Output only. The time when the scan was created.

updateTimestring google-datetime

Output only. The time when the scan was last updated.

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'CREATING' | 'DELETING' | 'ACTION_REQUIRED'

Output only. Current state of the DataScan.

Output only. The type of DataScan.

Response

Successful response