Google Cloud Dataplex V1 Client - Class ListDataScansRequest (0.11.1)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListDataScansRequest.

List dataScans request.

Generated from protobuf message google.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}` where `project` refers to a project_id or project_number and `location_id` refers 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 previous `ListDataScans` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataScans` must match the call that provided the page token.
`↳ filter`	`string` Optional. Filter request.
`↳ order_by`	`string` Optional. Order by fields (`name` or `create_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} where project refers to a project_id or project_number and location_id refers to a GCP region.

Returns
Type	Description
`string`

setParent

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 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 previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans must match the call that provided the page token.

Returns
Type	Description
`string`

setPageToken

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 (name or create_time) for the result.

If not specified, the ordering is undefined.

Returns
Type	Description
`string`

setOrderBy

Optional. Order by fields (name or create_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}` where `project` refers to a project_id or project_number and `location_id` refers to a GCP region. Please see Google\Cloud\Dataplex\V1\DataScanServiceClient::locationName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\ListDataScansRequest`