Google Cloud Document Ai V1 Client - Class ListEvaluationsRequest (1.3.0)

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

Retrieves a list of evaluations for a given ProcessorVersion.

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

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the ProcessorVersion to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

↳ page_size int

The standard list page size. If unspecified, at most 5 evaluations will be returned. The maximum value is 100; values above 100 will be coerced to 100.

↳ page_token string

A page token, received from a previous ListEvaluations call. Provide this to retrieve the subsequent page.

getParent

Required. The resource name of the ProcessorVersion to list evaluations for.

projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns
TypeDescription
string

setParent

Required. The resource name of the ProcessorVersion to list evaluations for.

projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The standard list page size.

If unspecified, at most 5 evaluations will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Returns
TypeDescription
int

setPageSize

The standard list page size.

If unspecified, at most 5 evaluations will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

A page token, received from a previous ListEvaluations call.

Provide this to retrieve the subsequent page.

Returns
TypeDescription
string

setPageToken

A page token, received from a previous ListEvaluations call.

Provide this to retrieve the subsequent page.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The resource name of the ProcessorVersion to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} Please see Google\Cloud\DocumentAI\V1\DocumentProcessorServiceClient::processorVersionName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\ListEvaluationsRequest