Method: projects.locations.dataScans.jobs.list

Lists DataScanJobs under the given DataScan.

HTTP request

GET https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*/dataScans/*}/jobs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the parent environment: projects/{project}/locations/{locationId}/dataScans/{dataScanId} where project refers to a projectId or project_number and locationId refers to a GCP region.

Authorization requires the following IAM permission on the specified resource parent:

  • dataplex.datascans.get

Query parameters

Parameters
pageSize

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.
pageToken

string

Optional. Page token received from a previous jobs.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to jobs.list must match the call that provided the page token.
filter

string

Optional. An expression for filtering the results of the jobs.list 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:

  • startTime
  • endTime

startTime and endTime expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00).

For instance, 'startTime > 2018-10-08T00:00:00.123456789Z AND endTime < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times.

Request body

The request body must be empty.

Response body

List DataScanJobs response.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "dataScanJobs": [
    {
      object (DataScanJob)
    }
  ],
  "nextPageToken": string
}
Fields
dataScanJobs[]

object (DataScanJob)

DataScanJobs (BASIC view only) under a given dataScan.
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.