Method: processorVersions.list

Full name: projects.locations.processors.processorVersions.list

Lists all versions of a processor.

HTTP request

GET https://{endpoint}/v1beta3/{parent}/processorVersions

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

Path parameters

Parameters
parent

string

Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor} It takes the form projects/{project}/locations/{location}/processors/{processor}.

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

  • documentai.processorVersions.list

Query parameters

Parameters
pageSize

integer

The maximum number of processor versions to return. If unspecified, at most 10 processor versions will be returned. The maximum value is 20. Values above 20 will be coerced to 20.

pageToken

string

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

Request body

The request body must be empty.

Response body

Response message for the processorVersions.list method.

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

JSON representation
{
  "processorVersions": [
    {
      object (ProcessorVersion)
    }
  ],
  "nextPageToken": string
}
Fields
processorVersions[]

object (ProcessorVersion)

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

For more information, see the IAM documentation.