Reference documentation and code samples for the Google Cloud Document Ai V1 Client class ListProcessorsRequest.
Request message for list all processors belongs to a project.
Generated from protobuf messagegoogle.cloud.documentai.v1.ListProcessorsRequest
Namespace
Google \ Cloud \ DocumentAI \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent (project and location) which owns this collection of Processors. Format:projects/{project}/locations/{location}
↳ page_size
int
The maximum number of processors to return. If unspecified, at most50processors will be returned. The maximum value is100. Values above100will be coerced to100.
↳ page_token
string
We will return the processors sorted by creation time. The page token will point to the next processor.
getParent
Required. The parent (project and location) which owns this collection of
Processors. Format:projects/{project}/locations/{location}
Returns
Type
Description
string
setParent
Required. The parent (project and location) which owns this collection of
Processors. Format:projects/{project}/locations/{location}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The maximum number of processors to return.
If unspecified, at most50processors will be returned.
The maximum value is100. Values above100will be coerced to100.
Returns
Type
Description
int
setPageSize
The maximum number of processors to return.
If unspecified, at most50processors will be returned.
The maximum value is100. Values above100will be coerced to100.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
We will return the processors sorted by creation time. The page token
will point to the next processor.
Returns
Type
Description
string
setPageToken
We will return the processors sorted by creation time. The page token
will point to the next processor.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parent (project and location) which owns this collection of
Processors. Format:projects/{project}/locations/{location}Please seeDocumentProcessorServiceClient::locationName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Document Ai V1 Client - Class ListProcessorsRequest (2.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.0 (latest)](/php/docs/reference/cloud-document-ai/latest/V1.ListProcessorsRequest)\n- [2.2.2](/php/docs/reference/cloud-document-ai/2.2.2/V1.ListProcessorsRequest)\n- [2.1.3](/php/docs/reference/cloud-document-ai/2.1.3/V1.ListProcessorsRequest)\n- [2.0.0](/php/docs/reference/cloud-document-ai/2.0.0/V1.ListProcessorsRequest)\n- [1.14.0](/php/docs/reference/cloud-document-ai/1.14.0/V1.ListProcessorsRequest)\n- [1.13.1](/php/docs/reference/cloud-document-ai/1.13.1/V1.ListProcessorsRequest)\n- [1.12.2](/php/docs/reference/cloud-document-ai/1.12.2/V1.ListProcessorsRequest)\n- [1.9.0](/php/docs/reference/cloud-document-ai/1.9.0/V1.ListProcessorsRequest)\n- [1.8.2](/php/docs/reference/cloud-document-ai/1.8.2/V1.ListProcessorsRequest)\n- [1.7.0](/php/docs/reference/cloud-document-ai/1.7.0/V1.ListProcessorsRequest)\n- [1.6.0](/php/docs/reference/cloud-document-ai/1.6.0/V1.ListProcessorsRequest)\n- [1.5.0](/php/docs/reference/cloud-document-ai/1.5.0/V1.ListProcessorsRequest)\n- [1.4.0](/php/docs/reference/cloud-document-ai/1.4.0/V1.ListProcessorsRequest)\n- [1.3.0](/php/docs/reference/cloud-document-ai/1.3.0/V1.ListProcessorsRequest)\n- [1.2.2](/php/docs/reference/cloud-document-ai/1.2.2/V1.ListProcessorsRequest)\n- [1.1.1](/php/docs/reference/cloud-document-ai/1.1.1/V1.ListProcessorsRequest)\n- [1.0.1](/php/docs/reference/cloud-document-ai/1.0.1/V1.ListProcessorsRequest) \nReference documentation and code samples for the Google Cloud Document Ai V1 Client class ListProcessorsRequest.\n\nRequest message for list all processors belongs to a project.\n\nGenerated from protobuf message `google.cloud.documentai.v1.ListProcessorsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DocumentAI \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent (project and location) which owns this collection of\nProcessors. Format: `projects/{project}/locations/{location}`\n\n### setParent\n\nRequired. The parent (project and location) which owns this collection of\nProcessors. Format: `projects/{project}/locations/{location}`\n\n### getPageSize\n\nThe maximum number of processors to return.\n\nIf unspecified, at most `50` processors will be returned.\nThe maximum value is `100`. Values above `100` will be coerced to `100`.\n\n### setPageSize\n\nThe maximum number of processors to return.\n\nIf unspecified, at most `50` processors will be returned.\nThe maximum value is `100`. Values above `100` will be coerced to `100`.\n\n### getPageToken\n\nWe will return the processors sorted by creation time. The page token\nwill point to the next processor.\n\n### setPageToken\n\nWe will return the processors sorted by creation time. The page token\nwill point to the next processor.\n\n### static::build"]]