com.google.cloud.documentai.v1beta3

Interface ListDocumentsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListDocumentsRequest, ListDocumentsRequest.Builder

public interface ListDocumentsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDataset() Required.
com.google.protobuf.ByteString	getDatasetBytes() Required.
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
int	getPageSize() The maximum number of documents to return.
String	getPageToken() A page token, received from a previous `ListDocuments` call.
com.google.protobuf.ByteString	getPageTokenBytes() A page token, received from a previous `ListDocuments` call.
boolean	getReturnTotalSize() Optional.
int	getSkip() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getDataset

String getDataset()

 Required. The resource name of the dataset to be listed.
 Format:
 projects/{project}/locations/{location}/processors/{processor}/dataset
 

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

Returns:

The dataset.

getDatasetBytes

com.google.protobuf.ByteString getDatasetBytes()

 Required. The resource name of the dataset to be listed.
 Format:
 projects/{project}/locations/{location}/processors/{processor}/dataset
 

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

Returns:

The bytes for dataset.

getPageSize

int getPageSize()

 The maximum number of documents to return. The service may return
 fewer than this value.
 If unspecified, at most 20 documents will be returned.
 The maximum value is 100; values above 100 will be coerced to 100.
 

int32 page_size = 2;

Returns:

The pageSize.

getPageToken

String getPageToken()

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

 When paginating, all other parameters provided to `ListDocuments`
 must match the call that provided the page token.
 

string page_token = 3;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

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

 When paginating, all other parameters provided to `ListDocuments`
 must match the call that provided the page token.
 

string page_token = 3;

Returns:

The bytes for pageToken.

getFilter

String getFilter()

 Optional. Query to filter the documents based on
 https://google.aip.dev/160.
 ## Currently support query strings are:

 `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED`
 - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED`
 - `DisplayName=\"file_name.pdf\"`
 - `EntityType=abc/def`
 - `TagName=\"auto-labeling-running\"|\"sampled\"`

 Note:
 - Only `AND`, `=` and `!=` are supported.
     e.g. `DisplayName=file_name AND EntityType!=abc` IS supported.
 - Wildcard `*` is supported only in `DisplayName` filter
 - No duplicate filter keys are allowed,
     e.g. `EntityType=a AND EntityType=b` is NOT supported.
 - String match is case sensitive (for filter `DisplayName` & `EntityType`).
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 Optional. Query to filter the documents based on
 https://google.aip.dev/160.
 ## Currently support query strings are:

 `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED`
 - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED`
 - `DisplayName=\"file_name.pdf\"`
 - `EntityType=abc/def`
 - `TagName=\"auto-labeling-running\"|\"sampled\"`

 Note:
 - Only `AND`, `=` and `!=` are supported.
     e.g. `DisplayName=file_name AND EntityType!=abc` IS supported.
 - Wildcard `*` is supported only in `DisplayName` filter
 - No duplicate filter keys are allowed,
     e.g. `EntityType=a AND EntityType=b` is NOT supported.
 - String match is case sensitive (for filter `DisplayName` & `EntityType`).
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for filter.

getReturnTotalSize

boolean getReturnTotalSize()

 Optional. Controls if the request requires a total size of matched
 documents. See
 [ListDocumentsResponse.total_size][google.cloud.documentai.v1beta3.ListDocumentsResponse.total_size].

 Enabling this flag may adversely impact performance.

 Defaults to false.
 

bool return_total_size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The returnTotalSize.

getSkip

int getSkip()

 Optional. Number of results to skip beginning from the `page_token` if
 provided. https://google.aip.dev/158#skipping-results. It must be a
 non-negative integer. Negative values will be rejected. Note that this is
 not the number of pages to skip. If this value causes the cursor to move
 past the end of results,
 [ListDocumentsResponse.document_metadata][google.cloud.documentai.v1beta3.ListDocumentsResponse.document_metadata]
 and
 [ListDocumentsResponse.next_page_token][google.cloud.documentai.v1beta3.ListDocumentsResponse.next_page_token]
 will be empty.
 

int32 skip = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The skip.