Reference documentation and code samples for the Google Cloud Dataplex V1 Client class CreateDataScanRequest.
Create dataScan request.
Generated from protobuf messagegoogle.cloud.dataplex.v1.CreateDataScanRequest
Namespace
Google \ Cloud \ Dataplex \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the parent location:projects/{project}/locations/{location_id}whereprojectrefers to aproject_idorproject_numberandlocation_idrefers to a GCP region.
Required. DataScan identifier. * * 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.
↳ validate_only
bool
Optional. Only validate the request, but do not perform mutations. The default isfalse.
getParent
Required. The resource name of the parent location:projects/{project}/locations/{location_id}whereprojectrefers to aproject_idorproject_numberandlocation_idrefers to a GCP region.
Returns
Type
Description
string
setParent
Required. The resource name of the parent location:projects/{project}/locations/{location_id}whereprojectrefers to aproject_idorproject_numberandlocation_idrefers to a GCP region.
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.
Returns
Type
Description
string
setDataScanId
Required. DataScan identifier.
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getValidateOnly
Optional. Only validate the request, but do not perform mutations.
The default isfalse.
Returns
Type
Description
bool
setValidateOnly
Optional. Only validate the request, but do not perform mutations.
The default isfalse.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
static::build
Parameters
Name
Description
parent
string
Required. The resource name of the parent location:projects/{project}/locations/{location_id}whereprojectrefers to aproject_idorproject_numberandlocation_idrefers to a GCP region. Please seeDataScanServiceClient::locationName()for help formatting this field.
[[["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,["# Google Cloud Dataplex V1 Client - Class CreateDataScanRequest (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.CreateDataScanRequest)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.CreateDataScanRequest)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.CreateDataScanRequest)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.CreateDataScanRequest)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.CreateDataScanRequest)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.CreateDataScanRequest)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.CreateDataScanRequest)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.CreateDataScanRequest)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.CreateDataScanRequest)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.CreateDataScanRequest)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.CreateDataScanRequest)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.CreateDataScanRequest)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.CreateDataScanRequest)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.CreateDataScanRequest)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.CreateDataScanRequest)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.CreateDataScanRequest)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.CreateDataScanRequest)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.CreateDataScanRequest)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.CreateDataScanRequest)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.CreateDataScanRequest)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.CreateDataScanRequest)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.CreateDataScanRequest)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.CreateDataScanRequest)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.CreateDataScanRequest) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class CreateDataScanRequest.\n\nCreate dataScan request.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.CreateDataScanRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The resource name of the parent location:\n`projects/{project}/locations/{location_id}`\nwhere `project` refers to a *project_id* or *project_number* and\n`location_id` refers to a GCP region.\n\n### setParent\n\nRequired. The resource name of the parent location:\n`projects/{project}/locations/{location_id}`\nwhere `project` refers to a *project_id* or *project_number* and\n`location_id` refers to a GCP region.\n\n### getDataScan\n\nRequired. DataScan resource.\n\n### hasDataScan\n\n### clearDataScan\n\n### setDataScan\n\nRequired. DataScan resource.\n\n### getDataScanId\n\nRequired. DataScan identifier.\n\n- Must contain only lowercase letters, numbers and hyphens.\n- Must start with a letter.\n- Must end with a number or a letter.\n- Must be between 1-63 characters.\n- Must be unique within the customer project / location.\n\n### setDataScanId\n\nRequired. DataScan identifier.\n\n- Must contain only lowercase letters, numbers and hyphens.\n- Must start with a letter.\n- Must end with a number or a letter.\n- Must be between 1-63 characters.\n- Must be unique within the customer project / location.\n\n### getValidateOnly\n\nOptional. Only validate the request, but do not perform mutations.\n\nThe default is `false`.\n\n### setValidateOnly\n\nOptional. Only validate the request, but do not perform mutations.\n\nThe default is `false`.\n\n### static::build"]]
