Class GoogleCloudDocumentaiV1beta3ListDocumentsRequest

Inheritance
object
GoogleCloudDocumentaiV1beta3ListDocumentsRequest
Implements
Inherited Members
Namespace: Google.Apis.Document.v1beta3.Data
Assembly: Google.Apis.Document.v1beta3.dll
Syntax
public class GoogleCloudDocumentaiV1beta3ListDocumentsRequest : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Filter

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).
Declaration
[JsonProperty("filter")]
public virtual string Filter { get; set; }
Property Value
Type Description
string

PageSize

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.

Declaration
[JsonProperty("pageSize")]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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.

Declaration
[JsonProperty("pageToken")]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

ReturnTotalSize

Optional. Controls if the request requires a total size of matched documents. See ListDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Defaults to false.

Declaration
[JsonProperty("returnTotalSize")]
public virtual bool? ReturnTotalSize { get; set; }
Property Value
Type Description
bool?

Skip

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 and ListDocumentsResponse.next_page_token will be empty.

Declaration
[JsonProperty("skip")]
public virtual int? Skip { get; set; }
Property Value
Type Description
int?

Implements