Google Cloud Document Ai V1 Client - Class ListProcessorsRequest (2.5.0)

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

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 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}

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 most 50 processors will be returned. The maximum value is 100. Values above 100 will be coerced to 100.

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.

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 see DocumentProcessorServiceClient::locationName() for help formatting this field.
Returns
Type Description
ListProcessorsRequest