Package com.google.cloud.documentai.v1beta3

Class ListDocumentsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder>
com.google.cloud.documentai.v1beta3.ListDocumentsRequest.Builder
All Implemented Interfaces:
ListDocumentsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListDocumentsRequest
public static final class ListDocumentsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder> implements ListDocumentsRequestOrBuilder
Protobuf type google.cloud.documentai.v1beta3.ListDocumentsRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder>

    • clear

      public ListDocumentsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder>

    • getDefaultInstanceForType

      public ListDocumentsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ListDocumentsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ListDocumentsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ListDocumentsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDocumentsRequest.Builder>

    • mergeFrom

      public ListDocumentsRequest.Builder mergeFrom(ListDocumentsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder>

    • mergeFrom

      public ListDocumentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDocumentsRequest.Builder>
      Throws:
      IOException

    • getDataset

      public 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) = { ... }
      Specified by:
      getDataset in interface ListDocumentsRequestOrBuilder
      Returns:
      The dataset.

    • getDatasetBytes

      public 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) = { ... }
      Specified by:
      getDatasetBytes in interface ListDocumentsRequestOrBuilder
      Returns:
      The bytes for dataset.

    • setDataset

      public ListDocumentsRequest.Builder setDataset(String value)
       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) = { ... }
      Parameters:
      value - The dataset to set.
      Returns:
      This builder for chaining.

    • clearDataset

      public ListDocumentsRequest.Builder clearDataset()
       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:
      This builder for chaining.

    • setDatasetBytes

      public ListDocumentsRequest.Builder setDatasetBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for dataset to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public 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;
      Specified by:
      getPageSize in interface ListDocumentsRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public ListDocumentsRequest.Builder setPageSize(int value)
       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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListDocumentsRequest.Builder clearPageSize()
       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:
      This builder for chaining.

    • getPageToken

      public 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;
      Specified by:
      getPageToken in interface ListDocumentsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public 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;
      Specified by:
      getPageTokenBytes in interface ListDocumentsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListDocumentsRequest.Builder setPageToken(String value)
       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;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListDocumentsRequest.Builder clearPageToken()
       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:
      This builder for chaining.

    • setPageTokenBytes

      public ListDocumentsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getFilter

      public 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];
      Specified by:
      getFilter in interface ListDocumentsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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];
      Specified by:
      getFilterBytes in interface ListDocumentsRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public ListDocumentsRequest.Builder setFilter(String value)
       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];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ListDocumentsRequest.Builder clearFilter()
       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:
      This builder for chaining.

    • setFilterBytes

      public ListDocumentsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getReturnTotalSize

      public 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];
      Specified by:
      getReturnTotalSize in interface ListDocumentsRequestOrBuilder
      Returns:
      The returnTotalSize.

    • setReturnTotalSize

      public ListDocumentsRequest.Builder setReturnTotalSize(boolean value)
       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];
      Parameters:
      value - The returnTotalSize to set.
      Returns:
      This builder for chaining.

    • clearReturnTotalSize

      public ListDocumentsRequest.Builder clearReturnTotalSize()
       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:
      This builder for chaining.

    • getSkip

      public 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];
      Specified by:
      getSkip in interface ListDocumentsRequestOrBuilder
      Returns:
      The skip.

    • setSkip

      public ListDocumentsRequest.Builder setSkip(int value)
       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];
      Parameters:
      value - The skip to set.
      Returns:
      This builder for chaining.

    • clearSkip

      public ListDocumentsRequest.Builder clearSkip()
       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:
      This builder for chaining.