Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListDataScanJobsRequest.
List DataScanJobs request.
Generated from protobuf message google.cloud.dataplex.v1.ListDataScanJobsRequest
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the parent environment: projects/{project}/locations/{location_id}/dataScans/{data_scan_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 DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs 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 ListDataScanJobs
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScanJobs
must match the call that provided the page token.
↳ filter
string
Optional. An expression for filtering the results of the ListDataScanJobs request. If unspecified, all datascan jobs will be returned. Multiple filters can be applied (with AND
, OR
logical operators). Filters are case-sensitive. Allowed fields are: - start_time
- end_time
start_time
and end_time
expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00). For instance, 'start_time > 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times.
getParent
Required. The resource name of the parent environment: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}
where project
refers to a project_id
or project_number
and location_id
refers to a GCP region.
string
setParent
Required. The resource name of the parent environment: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}
where project
refers to a project_id
or project_number
and location_id
refers to a GCP region.
var
string
$this
getPageSize
Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int
setPageSize
Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
var
int
$this
getPageToken
Optional. Page token received from a previous ListDataScanJobs
call.
Provide this to retrieve the subsequent page. When paginating, all other
parameters provided to ListDataScanJobs
must match the call that provided
the page token.
string
setPageToken
Optional. Page token received from a previous ListDataScanJobs
call.
Provide this to retrieve the subsequent page. When paginating, all other
parameters provided to ListDataScanJobs
must match the call that provided
the page token.
var
string
$this
getFilter
Optional. An expression for filtering the results of the ListDataScanJobs request.
If unspecified, all datascan jobs will be returned. Multiple filters can be
applied (with AND
, OR
logical operators). Filters are case-sensitive.
Allowed fields are:
-
start_time
-
end_time
start_time
andend_time
expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00). For instance, 'start_time > 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times.
string
setFilter
Optional. An expression for filtering the results of the ListDataScanJobs request.
If unspecified, all datascan jobs will be returned. Multiple filters can be
applied (with AND
, OR
logical operators). Filters are case-sensitive.
Allowed fields are:
-
start_time
-
end_time
start_time
andend_time
expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00). For instance, 'start_time > 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times.
var
string
$this
static::build
parent
string
Required. The resource name of the parent environment: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}
where project
refers to a project_id
or project_number
and location_id
refers to a GCP region. Please see DataScanServiceClient::dataScanName()
for help formatting this field.