Document AI V1beta3 API - Class Google::Cloud::DocumentAI::V1beta3::ListDocumentsRequest (v0.29.0)

Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::ListDocumentsRequest.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#dataset

def dataset() -> ::String
Returns
  • (::String) — Required. The resource name of the dataset to be listed. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

#dataset=

def dataset=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the dataset to be listed. Format: projects/{project}/locations/{location}/processors/{processor}/dataset
Returns
  • (::String) — Required. The resource name of the dataset to be listed. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

#filter

def filter() -> ::String
Returns
  • (::String) —

    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).

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    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).
Returns
  • (::String) —

    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).

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#page_token

def page_token() -> ::String
Returns
  • (::String) — 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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#return_total_size

def return_total_size() -> ::Boolean
Returns
  • (::Boolean) — Optional. Controls if the ListDocuments request requires a total size of matched documents. See ListDocumentsResponse.total_size.

    Enabling this flag may adversely impact performance.

    Defaults to false.

#return_total_size=

def return_total_size=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Controls if the ListDocuments request requires a total size of matched documents. See ListDocumentsResponse.total_size.

    Enabling this flag may adversely impact performance.

    Defaults to false.

Returns
  • (::Boolean) — Optional. Controls if the ListDocuments request requires a total size of matched documents. See ListDocumentsResponse.total_size.

    Enabling this flag may adversely impact performance.

    Defaults to false.

#skip

def skip() -> ::Integer
Returns
  • (::Integer) — 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 wil 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.

#skip=

def skip=(value) -> ::Integer
Parameter
  • value (::Integer) — 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 wil 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.
Returns
  • (::Integer) — 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 wil 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.