Method: processorTypes.list

Full name: projects.locations.processorTypes.list

Lists the processor types that exist.

HTTP request

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

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

Path parameters

Parameters
parent

string

Required. The location of processor types to list. 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.processorTypes.list

Query parameters

Parameters
pageSize

integer

The maximum number of processor types to return. If unspecified, at most 100 processor types will be returned. The maximum value is 500. Values above 500 will be coerced to 500.
pageToken

string

Used to retrieve the next page of results, empty if at the end of the list.

Request body

The request body must be empty.

Response body

Response message for the processorTypes.list method.

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

JSON representation 
{
  "processorTypes": [
    {
      object (ProcessorType)
    }
  ],
  "nextPageToken": string
}
Fields
processorTypes[]

object (ProcessorType)

The processor types.
nextPageToken

string

Points to the next page, 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.processorTypes.list

For more information, see the IAM documentation.