Method: projects.locations.batchPredictionJobs.list

Stay organized with collections Save and categorize content based on your preferences.

Lists BatchPredictionJobs in a Location.

HTTP request

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

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

Path parameters

Parameters
parent

string

Required. The resource name of the Location to list the BatchPredictionJobs from. Format: projects/{project}/locations/{location}

Query parameters

Parameters
filter

string

The standard list filter.

Supported fields:

  • displayName supports =, != comparisons, and : wildcard.
  • modelDisplayName supports =, != comparisons.
  • state supports =, != comparisons.
  • createTime supports =, !=,<, <=,>, >= comparisons. createTime must be in RFC 3339 format.
  • labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence

Some examples of using the filter are:

  • state="JOB_STATE_SUCCEEDED" AND displayName:"my_job_*"
  • state!="JOB_STATE_FAILED" OR displayName="my_job"
  • NOT displayName="my_job"
  • createTime>"2021-05-18T00:00:00Z"
  • labels.keyA=valueA
  • labels.keyB:*
pageSize

integer

The standard list page size.

pageToken

string

The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.

readMask

string (FieldMask format)

Mask specifying which fields to read.

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

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

JSON representation
{
  "batchPredictionJobs": [
    {
      object (BatchPredictionJob)
    }
  ],
  "nextPageToken": string
}
Fields
batchPredictionJobs[]

object (BatchPredictionJob)

List of BatchPredictionJobs in the requested page.

nextPageToken

string

A token to retrieve the next page of results. Pass to ListBatchPredictionJobsRequest.page_token to obtain that page.

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.batchPredictionJobs.list

For more information, see the IAM documentation.