Method: processors.list

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

Full name: projects.locations.processors.list

Lists all processors which belong to this project.

HTTP request

GET https://{endpoint}/v1/{parent}/processors

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

Path parameters

Parameters
parent

string

Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location} It takes the form projects/{project}/locations/{location}.

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

  • documentai.processors.list

Query parameters

Parameters
pageSize

integer

The maximum number of processors to return. If unspecified, at most 50 processors will be returned. The maximum value is 100; values above 100 will be coerced to 100.

pageToken

string

We will return the processors sorted by creation time. The page token will point to the next processor.

Request body

The request body must be empty.

Response body

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

Response message for list processors.

JSON representation
{
  "processors": [
    {
      object (Processor)
    }
  ],
  "nextPageToken": string
}
Fields
processors[]

object (Processor)

The list of processors.

nextPageToken

string

Points to the next processor, otherwise empty.

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:

  • documentai.processors.list

For more information, see the IAM documentation.