Method: projects.locations.dataLabelingJobs.list

Lists DataLabelingJobs in a Location.

HTTP request

GET https://{service-endpoint}/v1beta1/{parent}/dataLabelingJobs

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}

Query parameters

Parameters
filter

string

The standard list filter.

Supported fields:

  • displayName supports = and !=.

  • state supports = and !=.

Some examples of using the filter are:

  • state="JOB_STATE_SUCCEEDED" AND displayName="my_job"

  • state="JOB_STATE_RUNNING" OR displayName="my_job"

  • NOT displayName="my_job"

  • state="JOB_STATE_FAILED"

pageSize

integer

The standard list page size.

pageToken

string

The standard list page token.

readMask

string (FieldMask format)

Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

orderBy

string

A comma-separated list of fields to order by, sorted in ascending order by default. Use desc after a field name for descending.

Request body

The request body must be empty.

Response body

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

Response message for JobService.ListDataLabelingJobs.

JSON representation
{
  "dataLabelingJobs": [
    {
      object (DataLabelingJob)
    }
  ],
  "nextPageToken": string
}
Fields
dataLabelingJobs[]

object (DataLabelingJob)

A list of DataLabelingJobs that matches the specified filter in the request.

nextPageToken

string

The standard List next-page token.

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:

  • aiplatform.dataLabelingJobs.list

For more information, see the IAM documentation.