Cloud Document AI v1beta3 API - Class ListDocumentsRequest (2.0.0-beta17) 

public sealed class ListDocumentsRequest : IMessage<ListDocumentsRequest>, IEquatable<ListDocumentsRequest>, IDeepCloneable<ListDocumentsRequest>, IBufferMessage, IMessage, IPageRequest

Inheritance

object > ListDocumentsRequest

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Constructors

ListDocumentsRequest()

public ListDocumentsRequest()

ListDocumentsRequest(ListDocumentsRequest)

public ListDocumentsRequest(ListDocumentsRequest other)
Parameter
NameDescription
otherListDocumentsRequest

Properties

Dataset

public string Dataset { get; set; }

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

Property Value
TypeDescription
string

DatasetAsDatasetName

public DatasetName DatasetAsDatasetName { get; set; }

DatasetName-typed view over the Dataset resource name property.

Property Value
TypeDescription
DatasetName

Filter

public string Filter { get; set; }

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).
Property Value
TypeDescription
string

PageSize

public int PageSize { get; set; }

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.

Property Value
TypeDescription
int

PageToken

public string PageToken { get; set; }

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.

Property Value
TypeDescription
string

ReturnTotalSize

public bool ReturnTotalSize { get; set; }

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.

Property Value
TypeDescription
bool

Skip

public int Skip { get; set; }

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.

Property Value
TypeDescription
int