Class ListDocumentsResponse (2.47.0) 

public final class ListDocumentsResponse extends GeneratedMessageV3 implements ListDocumentsResponseOrBuilder

Protobuf type google.cloud.documentai.v1beta3.ListDocumentsResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListDocumentsResponse

Static Fields

DOCUMENT_METADATA_FIELD_NUMBER

public static final int DOCUMENT_METADATA_FIELD_NUMBER
Field Value
Type Description
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_SIZE_FIELD_NUMBER

public static final int TOTAL_SIZE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListDocumentsResponse getDefaultInstance()
Returns
Type Description
ListDocumentsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListDocumentsResponse.Builder newBuilder()
Returns
Type Description
ListDocumentsResponse.Builder

newBuilder(ListDocumentsResponse prototype)

public static ListDocumentsResponse.Builder newBuilder(ListDocumentsResponse prototype)
Parameter
Name Description
prototype ListDocumentsResponse
Returns
Type Description
ListDocumentsResponse.Builder

parseDelimitedFrom(InputStream input)

public static ListDocumentsResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListDocumentsResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListDocumentsResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListDocumentsResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListDocumentsResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListDocumentsResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListDocumentsResponse> parser()
Returns
Type Description
Parser<ListDocumentsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListDocumentsResponse getDefaultInstanceForType()
Returns
Type Description
ListDocumentsResponse

getDocumentMetadata(int index)

public DocumentMetadata getDocumentMetadata(int index)

Document metadata corresponding to the listed documents.

repeated .google.cloud.documentai.v1beta3.DocumentMetadata document_metadata = 1;

Parameter
Name Description
index int
Returns
Type Description
DocumentMetadata

getDocumentMetadataCount()

public int getDocumentMetadataCount()

Document metadata corresponding to the listed documents.

repeated .google.cloud.documentai.v1beta3.DocumentMetadata document_metadata = 1;

Returns
Type Description
int

getDocumentMetadataList()

public List<DocumentMetadata> getDocumentMetadataList()

Document metadata corresponding to the listed documents.

repeated .google.cloud.documentai.v1beta3.DocumentMetadata document_metadata = 1;

Returns
Type Description
List<DocumentMetadata>

getDocumentMetadataOrBuilder(int index)

public DocumentMetadataOrBuilder getDocumentMetadataOrBuilder(int index)

Document metadata corresponding to the listed documents.

repeated .google.cloud.documentai.v1beta3.DocumentMetadata document_metadata = 1;

Parameter
Name Description
index int
Returns
Type Description
DocumentMetadataOrBuilder

getDocumentMetadataOrBuilderList()

public List<? extends DocumentMetadataOrBuilder> getDocumentMetadataOrBuilderList()

Document metadata corresponding to the listed documents.

repeated .google.cloud.documentai.v1beta3.DocumentMetadata document_metadata = 1;

Returns
Type Description
List<? extends com.google.cloud.documentai.v1beta3.DocumentMetadataOrBuilder>

getNextPageToken()

public String getNextPageToken()

A token, which can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 2;

Returns
Type Description
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

A token, which can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 2;

Returns
Type Description
ByteString

The bytes for nextPageToken.

getParserForType()

public Parser<ListDocumentsResponse> getParserForType()
Returns
Type Description
Parser<ListDocumentsResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalSize()

public int getTotalSize()

Total count of documents queried.

int32 total_size = 3;

Returns
Type Description
int

The totalSize.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListDocumentsResponse.Builder newBuilderForType()
Returns
Type Description
ListDocumentsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListDocumentsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListDocumentsResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListDocumentsResponse.Builder toBuilder()
Returns
Type Description
ListDocumentsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException