Package com.google.cloud.documentai.v1beta3

Class ListDocumentsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1beta3.ListDocumentsRequest
All Implemented Interfaces:
ListDocumentsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ListDocumentsRequest extends com.google.protobuf.GeneratedMessage implements ListDocumentsRequestOrBuilder
Protobuf type google.cloud.documentai.v1beta3.ListDocumentsRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ListDocumentsRequest.Builder
    Protobuf type google.cloud.documentai.v1beta3.ListDocumentsRequest

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DATASET_FIELD_NUMBER
     
    static final int
    FILTER_FIELD_NUMBER
     
    static final int
    PAGE_SIZE_FIELD_NUMBER
     
    static final int
    PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    RETURN_TOTAL_SIZE_FIELD_NUMBER
     
    static final int
    SKIP_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getDataset()
    Required.
    com.google.protobuf.ByteString
    getDatasetBytes()
    Required.
    static ListDocumentsRequest
    getDefaultInstance()
     
    ListDocumentsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<ListDocumentsRequest>
    getParserForType()
     
    boolean
    getReturnTotalSize()
    Optional.
    int
    getSerializedSize()
     
    int
    getSkip()
    Optional.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ListDocumentsRequest.Builder
    newBuilder()
     
    static ListDocumentsRequest.Builder
    newBuilder(ListDocumentsRequest prototype)
     
    ListDocumentsRequest.Builder
    newBuilderForType()
     
    protected ListDocumentsRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ListDocumentsRequest
    parseDelimitedFrom(InputStream input)
     
    static ListDocumentsRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListDocumentsRequest
    parseFrom(byte[] data)
     
    static ListDocumentsRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListDocumentsRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ListDocumentsRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListDocumentsRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ListDocumentsRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListDocumentsRequest
    parseFrom(InputStream input)
     
    static ListDocumentsRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListDocumentsRequest
    parseFrom(ByteBuffer data)
     
    static ListDocumentsRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListDocumentsRequest>
    parser()
     
    ListDocumentsRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • 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

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

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

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

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

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

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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ListDocumentsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListDocumentsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListDocumentsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListDocumentsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListDocumentsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListDocumentsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListDocumentsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListDocumentsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListDocumentsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListDocumentsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static ListDocumentsRequest.Builder newBuilder()

    • newBuilder

      public static ListDocumentsRequest.Builder newBuilder(ListDocumentsRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected ListDocumentsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ListDocumentsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListDocumentsRequest> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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