Package com.google.cloud.documentai.v1

Interface ListEvaluationsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListEvaluationsRequest, ListEvaluationsRequest.Builder
@Generated public interface ListEvaluationsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPageSize()
    The standard list page size.
    String
    getPageToken()
    A page token, received from a previous `ListEvaluations` call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous `ListEvaluations` call.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       Required. The resource name of the
 [ProcessorVersion][google.cloud.documentai.v1.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:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The resource name of the
 [ProcessorVersion][google.cloud.documentai.v1.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:
      The bytes for parent.

    • getPageSize

      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:
      The pageSize.

    • getPageToken

      String getPageToken()
       A page token, received from a previous `ListEvaluations` call.
 Provide this to retrieve the subsequent page.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       A page token, received from a previous `ListEvaluations` call.
 Provide this to retrieve the subsequent page.
      string page_token = 3;
      Returns:
      The bytes for pageToken.