Package com.google.cloud.documentai.v1beta3

Class ListDocumentsResponse

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

  • Nested Class Summary

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

    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
    DOCUMENT_METADATA_FIELD_NUMBER
     
    static final int
    NEXT_PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    TOTAL_SIZE_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)
     
    static ListDocumentsResponse
    getDefaultInstance()
     
    ListDocumentsResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    DocumentMetadata
    getDocumentMetadata(int index)
    Document metadata corresponding to the listed documents.
    int
    getDocumentMetadataCount()
    Document metadata corresponding to the listed documents.
    List<DocumentMetadata>
    getDocumentMetadataList()
    Document metadata corresponding to the listed documents.
    DocumentMetadataOrBuilder
    getDocumentMetadataOrBuilder(int index)
    Document metadata corresponding to the listed documents.
    List<? extends DocumentMetadataOrBuilder>
    getDocumentMetadataOrBuilderList()
    Document metadata corresponding to the listed documents.
    String
    getNextPageToken()
    A token, which can be sent as [ListDocumentsRequest.page_token][google.cloud.documentai.v1beta3.ListDocumentsRequest.page_token] to retrieve the next page.
    com.google.protobuf.ByteString
    getNextPageTokenBytes()
    A token, which can be sent as [ListDocumentsRequest.page_token][google.cloud.documentai.v1beta3.ListDocumentsRequest.page_token] to retrieve the next page.
    com.google.protobuf.Parser<ListDocumentsResponse>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    getTotalSize()
    Total count of documents queried.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ListDocumentsResponse.Builder
    newBuilder()
     
    static ListDocumentsResponse.Builder
    newBuilder(ListDocumentsResponse prototype)
     
    ListDocumentsResponse.Builder
    newBuilderForType()
     
    protected ListDocumentsResponse.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ListDocumentsResponse
    parseDelimitedFrom(InputStream input)
     
    static ListDocumentsResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListDocumentsResponse
    parseFrom(byte[] data)
     
    static ListDocumentsResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListDocumentsResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static ListDocumentsResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListDocumentsResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ListDocumentsResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListDocumentsResponse
    parseFrom(InputStream input)
     
    static ListDocumentsResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListDocumentsResponse
    parseFrom(ByteBuffer data)
     
    static ListDocumentsResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListDocumentsResponse>
    parser()
     
    ListDocumentsResponse.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

    • DOCUMENT_METADATA_FIELD_NUMBER

      public static final int DOCUMENT_METADATA_FIELD_NUMBER
      See Also:

    • NEXT_PAGE_TOKEN_FIELD_NUMBER

      public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
      See Also:

    • TOTAL_SIZE_FIELD_NUMBER

      public static final int TOTAL_SIZE_FIELD_NUMBER
      See Also:

  • 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

    • getDocumentMetadataList

      public List<DocumentMetadata> getDocumentMetadataList()
       Document metadata corresponding to the listed documents.
      repeated .google.cloud.documentai.v1beta3.DocumentMetadata document_metadata = 1;
      Specified by:
      getDocumentMetadataList in interface ListDocumentsResponseOrBuilder

    • getDocumentMetadataOrBuilderList

      public List<? extends DocumentMetadataOrBuilder> getDocumentMetadataOrBuilderList()
       Document metadata corresponding to the listed documents.
      repeated .google.cloud.documentai.v1beta3.DocumentMetadata document_metadata = 1;
      Specified by:
      getDocumentMetadataOrBuilderList in interface ListDocumentsResponseOrBuilder

    • getDocumentMetadataCount

      public int getDocumentMetadataCount()
       Document metadata corresponding to the listed documents.
      repeated .google.cloud.documentai.v1beta3.DocumentMetadata document_metadata = 1;
      Specified by:
      getDocumentMetadataCount in interface ListDocumentsResponseOrBuilder

    • getDocumentMetadata

      public DocumentMetadata getDocumentMetadata(int index)
       Document metadata corresponding to the listed documents.
      repeated .google.cloud.documentai.v1beta3.DocumentMetadata document_metadata = 1;
      Specified by:
      getDocumentMetadata in interface ListDocumentsResponseOrBuilder

    • getDocumentMetadataOrBuilder

      public DocumentMetadataOrBuilder getDocumentMetadataOrBuilder(int index)
       Document metadata corresponding to the listed documents.
      repeated .google.cloud.documentai.v1beta3.DocumentMetadata document_metadata = 1;
      Specified by:
      getDocumentMetadataOrBuilder in interface ListDocumentsResponseOrBuilder

    • getNextPageToken

      public String getNextPageToken()
       A token, which can be sent as
 [ListDocumentsRequest.page_token][google.cloud.documentai.v1beta3.ListDocumentsRequest.page_token]
 to retrieve the next page. If this field is omitted, there are no
 subsequent pages.
      string next_page_token = 2;
      Specified by:
      getNextPageToken in interface ListDocumentsResponseOrBuilder
      Returns:
      The nextPageToken.

    • getNextPageTokenBytes

      public com.google.protobuf.ByteString getNextPageTokenBytes()
       A token, which can be sent as
 [ListDocumentsRequest.page_token][google.cloud.documentai.v1beta3.ListDocumentsRequest.page_token]
 to retrieve the next page. If this field is omitted, there are no
 subsequent pages.
      string next_page_token = 2;
      Specified by:
      getNextPageTokenBytes in interface ListDocumentsResponseOrBuilder
      Returns:
      The bytes for nextPageToken.

    • getTotalSize

      public int getTotalSize()
       Total count of documents queried.
      int32 total_size = 3;
      Specified by:
      getTotalSize in interface ListDocumentsResponseOrBuilder
      Returns:
      The totalSize.

    • 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 ListDocumentsResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ListDocumentsResponse.Builder newBuilder()

    • newBuilder

      public static ListDocumentsResponse.Builder newBuilder(ListDocumentsResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ListDocumentsResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ListDocumentsResponse> 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 ListDocumentsResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder