Google Cloud Document Ai V1 Client - Class ListProcessorTypesRequest (1.12.1)

Version 1.12.1

• 2.0.0 (latest)
• 1.13.0
• 1.12.2
• 1.9.0
• 1.8.2
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.2
• 1.1.1
• 1.0.1

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class ListProcessorTypesRequest.

Request message for the ListProcessorTypes method.

Some processor types may require the project be added to an allowlist.

Generated from protobuf message google.cloud.documentai.v1.ListProcessorTypesRequest

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The location of processor types to list. Format: projects/{project}/locations/{location}.
↳ page_size	int 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.
↳ page_token	string Used to retrieve the next page of results, empty if at the end of the list.

getParent

Required. The location of processor types to list.

Format: projects/{project}/locations/{location}.

Returns
Type	Description
string

setParent

Required. The location of processor types to list.

Format: projects/{project}/locations/{location}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

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.

Returns
Type	Description
int

setPageSize

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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

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

Returns
Type	Description
string

setPageToken

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The location of processor types to list. Format: projects/{project}/locations/{location}. Please see Google\Cloud\DocumentAI\V1\DocumentProcessorServiceClient::locationName() for help formatting this field.

Returns
Type	Description
Google\Cloud\DocumentAI\V1\ListProcessorTypesRequest