Class ListDocumentsResponse.Builder (2.87.0)

public static final class ListDocumentsResponse.Builder extends GeneratedMessage.Builder<ListDocumentsResponse.Builder> implements ListDocumentsResponseOrBuilder

Protobuf type google.cloud.documentai.v1beta3.ListDocumentsResponse

Static Methods

getDescriptor()

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

Methods

addAllDocumentMetadata(Iterable<? extends DocumentMetadata> values)

public ListDocumentsResponse.Builder addAllDocumentMetadata(Iterable<? extends DocumentMetadata> values)

Document metadata corresponding to the listed documents.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.documentai.v1beta3.DocumentMetadata>
Returns
Type Description
ListDocumentsResponse.Builder

addDocumentMetadata(DocumentMetadata value)

public ListDocumentsResponse.Builder addDocumentMetadata(DocumentMetadata value)

Document metadata corresponding to the listed documents.

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

Parameter
Name Description
value DocumentMetadata
Returns
Type Description
ListDocumentsResponse.Builder

addDocumentMetadata(DocumentMetadata.Builder builderForValue)

public ListDocumentsResponse.Builder addDocumentMetadata(DocumentMetadata.Builder builderForValue)

Document metadata corresponding to the listed documents.

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

Parameter
Name Description
builderForValue DocumentMetadata.Builder
Returns
Type Description
ListDocumentsResponse.Builder

addDocumentMetadata(int index, DocumentMetadata value)

public ListDocumentsResponse.Builder addDocumentMetadata(int index, DocumentMetadata value)

Document metadata corresponding to the listed documents.

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

Parameters
Name Description
index int
value DocumentMetadata
Returns
Type Description
ListDocumentsResponse.Builder

addDocumentMetadata(int index, DocumentMetadata.Builder builderForValue)

public ListDocumentsResponse.Builder addDocumentMetadata(int index, DocumentMetadata.Builder builderForValue)

Document metadata corresponding to the listed documents.

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

Parameters
Name Description
index int
builderForValue DocumentMetadata.Builder
Returns
Type Description
ListDocumentsResponse.Builder

addDocumentMetadataBuilder()

public DocumentMetadata.Builder addDocumentMetadataBuilder()

Document metadata corresponding to the listed documents.

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

Returns
Type Description
DocumentMetadata.Builder

addDocumentMetadataBuilder(int index)

public DocumentMetadata.Builder addDocumentMetadataBuilder(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.Builder

build()

public ListDocumentsResponse build()
Returns
Type Description
ListDocumentsResponse

buildPartial()

public ListDocumentsResponse buildPartial()
Returns
Type Description
ListDocumentsResponse

clear()

public ListDocumentsResponse.Builder clear()
Returns
Type Description
ListDocumentsResponse.Builder
Overrides

clearDocumentMetadata()

public ListDocumentsResponse.Builder clearDocumentMetadata()

Document metadata corresponding to the listed documents.

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

Returns
Type Description
ListDocumentsResponse.Builder

clearNextPageToken()

public ListDocumentsResponse.Builder clearNextPageToken()

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
ListDocumentsResponse.Builder

This builder for chaining.

clearTotalSize()

public ListDocumentsResponse.Builder clearTotalSize()

Total count of documents queried.

int32 total_size = 3;

Returns
Type Description
ListDocumentsResponse.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListDocumentsResponse getDefaultInstanceForType()
Returns
Type Description
ListDocumentsResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getDocumentMetadataBuilder(int index)

public DocumentMetadata.Builder getDocumentMetadataBuilder(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.Builder

getDocumentMetadataBuilderList()

public List<DocumentMetadata.Builder> getDocumentMetadataBuilderList()

Document metadata corresponding to the listed documents.

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

Returns
Type Description
List<Builder>

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.

getTotalSize()

public int getTotalSize()

Total count of documents queried.

int32 total_size = 3;

Returns
Type Description
int

The totalSize.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListDocumentsResponse other)

public ListDocumentsResponse.Builder mergeFrom(ListDocumentsResponse other)
Parameter
Name Description
other ListDocumentsResponse
Returns
Type Description
ListDocumentsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListDocumentsResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListDocumentsResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListDocumentsResponse.Builder
Overrides

removeDocumentMetadata(int index)

public ListDocumentsResponse.Builder removeDocumentMetadata(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
ListDocumentsResponse.Builder

setDocumentMetadata(int index, DocumentMetadata value)

public ListDocumentsResponse.Builder setDocumentMetadata(int index, DocumentMetadata value)

Document metadata corresponding to the listed documents.

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

Parameters
Name Description
index int
value DocumentMetadata
Returns
Type Description
ListDocumentsResponse.Builder

setDocumentMetadata(int index, DocumentMetadata.Builder builderForValue)

public ListDocumentsResponse.Builder setDocumentMetadata(int index, DocumentMetadata.Builder builderForValue)

Document metadata corresponding to the listed documents.

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

Parameters
Name Description
index int
builderForValue DocumentMetadata.Builder
Returns
Type Description
ListDocumentsResponse.Builder

setNextPageToken(String value)

public ListDocumentsResponse.Builder setNextPageToken(String value)

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;

Parameter
Name Description
value String

The nextPageToken to set.

Returns
Type Description
ListDocumentsResponse.Builder

This builder for chaining.

setNextPageTokenBytes(ByteString value)

public ListDocumentsResponse.Builder setNextPageTokenBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for nextPageToken to set.

Returns
Type Description
ListDocumentsResponse.Builder

This builder for chaining.

setTotalSize(int value)

public ListDocumentsResponse.Builder setTotalSize(int value)

Total count of documents queried.

int32 total_size = 3;

Parameter
Name Description
value int

The totalSize to set.

Returns
Type Description
ListDocumentsResponse.Builder

This builder for chaining.