Method: googleapis.documentai.v1.projects.locations.processorTypes.list

Lists the processor types that exist.

Arguments

Parameters
parent

string

Required. The location of processor type to list. The available processor types may depend on the allow-listing on projects. Format: projects/{project}/locations/{location}

pageSize

integer (int32 format)

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.

location

string

Location of the HTTP endpoint: us or eu. If not set, us is used by default.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of GoogleCloudDocumentaiV1ListProcessorTypesResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.documentai.v1.projects.locations.processorTypes.list
    args:
        parent: ...
        pageSize: ...
        pageToken: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.documentai.v1.projects.locations.processorTypes.list",
      "args": {
        "parent": "...",
        "pageSize": "...",
        "pageToken": "..."
      },
      "result": "listResult"
    }
  }
]