projects

Changed on

Creates a DataScan resource.

post/v1/{+parent}/dataScans

Request

  • Base URL: https://dataplex.googleapis.com
  • URL: https://dataplex.googleapis.com/v1/{+parent}/dataScans
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/dataplex.read-write) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/dataplex.read-write)

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

createTimestring google-datetime

Output only. The time when the scan was created.

descriptionstring

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

displayNamestring

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

labelsobject

Optional. User-defined labels for the scan.

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.

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

Output only. Current state of the DataScan.

type'DATA_SCAN_TYPE_UNSPECIFIED' | 'DATA_QUALITY' | 'DATA_PROFILE' | 'DATA_DISCOVERY' | 'DATA_DOCUMENTATION'

Output only. The type of DataScan.

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.

updateTimestring google-datetime

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

Response

Successful response

Changes

  • 6c7e9028cba8Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2c

  • 395bfc8abfeeRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2c