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 message google.cloud.documentai.v1.ListProcessorsRequest
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: |
↳ page_size |
int
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. |
↳ 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}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent (project and location) which owns this collection of Processors.
Format: projects/{project}/locations/{location}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
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.
Generated from protobuf field int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
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.
Generated from protobuf field int32 page_size = 2;
| 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.
Generated from protobuf field string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
We will return the processors sorted by creation time. The page token will point to the next processor.
Generated from protobuf field string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|