Class ListEvaluationsRequest.Builder (2.87.0)

public static final class ListEvaluationsRequest.Builder extends GeneratedMessage.Builder<ListEvaluationsRequest.Builder> implements ListEvaluationsRequestOrBuilder

Retrieves a list of evaluations for a given ProcessorVersion.

Protobuf type google.cloud.documentai.v1.ListEvaluationsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ListEvaluationsRequest build()
Returns
Type Description
ListEvaluationsRequest

buildPartial()

public ListEvaluationsRequest buildPartial()
Returns
Type Description
ListEvaluationsRequest

clear()

public ListEvaluationsRequest.Builder clear()
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

clearPageSize()

public ListEvaluationsRequest.Builder clearPageSize()

The standard list page size. If unspecified, at most 5 evaluations are returned. The maximum value is 100. Values above 100 are coerced to 100.

int32 page_size = 2;

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

clearPageToken()

public ListEvaluationsRequest.Builder clearPageToken()

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

string page_token = 3;

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

clearParent()

public ListEvaluationsRequest.Builder clearParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListEvaluationsRequest getDefaultInstanceForType()
Returns
Type Description
ListEvaluationsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

public int getPageSize()

The standard list page size. If unspecified, at most 5 evaluations are returned. The maximum value is 100. Values above 100 are coerced to 100.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListEvaluationsRequest other)

public ListEvaluationsRequest.Builder mergeFrom(ListEvaluationsRequest other)
Parameter
Name Description
other ListEvaluationsRequest
Returns
Type Description
ListEvaluationsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListEvaluationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListEvaluationsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

setPageSize(int value)

public ListEvaluationsRequest.Builder setPageSize(int value)

The standard list page size. If unspecified, at most 5 evaluations are returned. The maximum value is 100. Values above 100 are coerced to 100.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListEvaluationsRequest.Builder setPageToken(String value)

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

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListEvaluationsRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setParent(String value)

public ListEvaluationsRequest.Builder setParent(String value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListEvaluationsRequest.Builder setParentBytes(ByteString value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.