Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListDataScansRequest.
List dataScans request.
Generated from protobuf messagegoogle.cloud.dataplex.v1.ListDataScansRequest
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.
↳ page_size
int
Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
↳ page_token
string
Optional. Page token received from a previousListDataScanscall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListDataScansmust match the call that provided the page token.
↳ filter
string
Optional. Filter request.
↳ order_by
string
Optional. Order by fields (nameorcreate_time) for the result. If not specified, the ordering is undefined.
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. Maximum number of dataScans to return. The service may return
fewer than this value. If unspecified, at most 500 scans will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
Returns
Type
Description
int
setPageSize
Optional. Maximum number of dataScans to return. The service may return
fewer than this value. If unspecified, at most 500 scans will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. Page token received from a previousListDataScanscall. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided toListDataScansmust match the call that provided the
page token.
Returns
Type
Description
string
setPageToken
Optional. Page token received from a previousListDataScanscall. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided toListDataScansmust match the call that provided the
page token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. Filter request.
Returns
Type
Description
string
setFilter
Optional. Filter request.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
Optional. Order by fields (nameorcreate_time) for the result.
If not specified, the ordering is undefined.
Returns
Type
Description
string
setOrderBy
Optional. Order by fields (nameorcreate_time) for the result.
If not specified, the ordering is undefined.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
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 ListDataScansRequest (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.ListDataScansRequest)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.ListDataScansRequest)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.ListDataScansRequest)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.ListDataScansRequest)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.ListDataScansRequest)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.ListDataScansRequest)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.ListDataScansRequest)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.ListDataScansRequest)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.ListDataScansRequest)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.ListDataScansRequest)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.ListDataScansRequest)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.ListDataScansRequest)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.ListDataScansRequest)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.ListDataScansRequest)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.ListDataScansRequest)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.ListDataScansRequest)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.ListDataScansRequest)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.ListDataScansRequest)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.ListDataScansRequest)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.ListDataScansRequest)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.ListDataScansRequest)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.ListDataScansRequest)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.ListDataScansRequest)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.ListDataScansRequest) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class ListDataScansRequest.\n\nList dataScans request.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.ListDataScansRequest`\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### getPageSize\n\nOptional. Maximum number of dataScans to return. The service may return\nfewer than this value. If unspecified, at most 500 scans will be returned.\n\nThe maximum value is 1000; values above 1000 will be coerced to 1000.\n\n### setPageSize\n\nOptional. Maximum number of dataScans to return. The service may return\nfewer than this value. If unspecified, at most 500 scans will be returned.\n\nThe maximum value is 1000; values above 1000 will be coerced to 1000.\n\n### getPageToken\n\nOptional. Page token received from a previous `ListDataScans` call. Provide\nthis to retrieve the subsequent page. When paginating, all other parameters\nprovided to `ListDataScans` must match the call that provided the\npage token.\n\n### setPageToken\n\nOptional. Page token received from a previous `ListDataScans` call. Provide\nthis to retrieve the subsequent page. When paginating, all other parameters\nprovided to `ListDataScans` must match the call that provided the\npage token.\n\n### getFilter\n\nOptional. Filter request.\n\n### setFilter\n\nOptional. Filter request.\n\n### getOrderBy\n\nOptional. Order by fields (`name` or `create_time`) for the result.\n\nIf not specified, the ordering is undefined.\n\n### setOrderBy\n\nOptional. Order by fields (`name` or `create_time`) for the result.\n\nIf not specified, the ordering is undefined.\n\n### static::build"]]
