Method: projects.locations.metadataJobs.list

Lists metadata jobs.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{locationId}

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

  • dataplex.metadataJobs.list

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.
pageToken

string

Optional. The page token received from a previous metadataJobs.list call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the metadataJobs.list request must match the call that provided the page token.
filter

string

Optional. Filter request. Filters are case-sensitive. The service supports the following formats:

  • labels.key1 = "value1"
  • labels:key1
  • name = "value"

You can combine filters with AND, OR, and NOT operators.
orderBy

string

Optional. The field to sort the results by, either name or createTime. If not specified, the ordering is undefined.

Request body

The request body must be empty.

Response body

List metadata jobs response.

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

JSON representation 
{
  "metadataJobs": [
    {
      object (MetadataJob)
    }
  ],
  "nextPageToken": string,
  "unreachableLocations": [
    string
  ]
}
Fields
metadataJobs[]

object (MetadataJob)

Metadata jobs under the specified parent location.
nextPageToken

string

A token to retrieve the next page of results. If there are no more results in the list, the value is empty.
unreachableLocations[]

string

Locations that the service couldn't reach.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • dataplex.metadataJobs.list

For more information, see the IAM documentation.