Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::ListDataScanJobsRequest.
List DataScanJobs request.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#filter
deffilter()->::String
Returns
(::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.
#filter=
deffilter=(value)->::String
Parameter
value (::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.
Returns
(::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.
#page_size
defpage_size()->::Integer
Returns
(::Integer) — 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_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — 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.
Returns
(::Integer) — 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
defpage_token()->::String
Returns
(::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.
#page_token=
defpage_token=(value)->::String
Parameter
value (::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.
Returns
(::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.
#parent
defparent()->::String
Returns
(::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.
#parent=
defparent=(value)->::String
Parameter
value (::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.
Returns
(::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.
[[["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,["# Dataplex V1 API - Class Google::Cloud::Dataplex::V1::ListDataScanJobsRequest (v2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/ruby/docs/reference/google-cloud-dataplex-v1/latest/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [2.4.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.4.1/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [2.3.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.3.1/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [2.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.2.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [2.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.1.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [2.0.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.0.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [1.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.4.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.3.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.2.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.1.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-dataplex-v1/1.0.1/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.23.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.23.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.22.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.22.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.21.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.21.1/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.20.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.20.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.19.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.19.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.18.2](/ruby/docs/reference/google-cloud-dataplex-v1/0.18.2/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.17.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.17.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.16.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.15.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.15.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.14.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.13.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.12.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.11.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.10.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.10.1/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.9.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.8.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.7.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.6.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.6.1/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.5.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.5.1/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.4.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.3.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.2.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.2.1/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.1.0/Google-Cloud-Dataplex-V1-ListDataScanJobsRequest) \nReference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::ListDataScanJobsRequest.\n\nList DataScanJobs request. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. An expression for filtering the results of the ListDataScanJobs request.\n\n If unspecified, all datascan jobs will be returned. Multiple filters can be\n applied (with `AND`, `OR` logical operators). Filters are case-sensitive.\n\n Allowed fields are:\n - `start_time`\n - `end_time`\n\n `start_time` and `end_time` expect RFC-3339 formatted strings (e.g.\n 2018-10-08T18:30:00-07:00).\n\n For instance, 'start_time \\\u003e 2018-10-08T00:00:00.123456789Z AND end_time \\\u003c\n 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between\n specified start and end times.\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. An expression for filtering the results of the ListDataScanJobs request.\n\n\n If unspecified, all datascan jobs will be returned. Multiple filters can be\n applied (with `AND`, `OR` logical operators). Filters are case-sensitive.\n\n Allowed fields are:\n - `start_time`\n - `end_time`\n\n `start_time` and `end_time` expect RFC-3339 formatted strings (e.g.\n 2018-10-08T18:30:00-07:00).\n\n For instance, 'start_time \\\u003e 2018-10-08T00:00:00.123456789Z AND end_time \\\u003c\n 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between\nspecified start and end times. \n**Returns**\n\n- (::String) --- Optional. An expression for filtering the results of the ListDataScanJobs request.\n\n If unspecified, all datascan jobs will be returned. Multiple filters can be\n applied (with `AND`, `OR` logical operators). Filters are case-sensitive.\n\n Allowed fields are:\n - `start_time`\n - `end_time`\n\n `start_time` and `end_time` expect RFC-3339 formatted strings (e.g.\n 2018-10-08T18:30:00-07:00).\n\n For instance, 'start_time \\\u003e 2018-10-08T00:00:00.123456789Z AND end_time \\\u003c\n 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between\n specified start and end times.\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- 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.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- 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. \n**Returns**\n\n- (::Integer) --- 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.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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."]]