Class SearchDocumentsResponse.Builder (0.28.0)

public static final class SearchDocumentsResponse.Builder extends GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder> implements SearchDocumentsResponseOrBuilder

Response message for DocumentService.SearchDocuments.

Protobuf type google.cloud.contentwarehouse.v1.SearchDocumentsResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllHistogramQueryResults(Iterable<? extends HistogramQueryResult> values)

public SearchDocumentsResponse.Builder addAllHistogramQueryResults(Iterable<? extends HistogramQueryResult> values)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.contentwarehouse.v1.HistogramQueryResult>
Returns
TypeDescription
SearchDocumentsResponse.Builder

addAllMatchingDocuments(Iterable<? extends SearchDocumentsResponse.MatchingDocument> values)

public SearchDocumentsResponse.Builder addAllMatchingDocuments(Iterable<? extends SearchDocumentsResponse.MatchingDocument> values)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument>
Returns
TypeDescription
SearchDocumentsResponse.Builder

addHistogramQueryResults(HistogramQueryResult value)

public SearchDocumentsResponse.Builder addHistogramQueryResults(HistogramQueryResult value)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameter
NameDescription
valueHistogramQueryResult
Returns
TypeDescription
SearchDocumentsResponse.Builder

addHistogramQueryResults(HistogramQueryResult.Builder builderForValue)

public SearchDocumentsResponse.Builder addHistogramQueryResults(HistogramQueryResult.Builder builderForValue)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameter
NameDescription
builderForValueHistogramQueryResult.Builder
Returns
TypeDescription
SearchDocumentsResponse.Builder

addHistogramQueryResults(int index, HistogramQueryResult value)

public SearchDocumentsResponse.Builder addHistogramQueryResults(int index, HistogramQueryResult value)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameters
NameDescription
indexint
valueHistogramQueryResult
Returns
TypeDescription
SearchDocumentsResponse.Builder

addHistogramQueryResults(int index, HistogramQueryResult.Builder builderForValue)

public SearchDocumentsResponse.Builder addHistogramQueryResults(int index, HistogramQueryResult.Builder builderForValue)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameters
NameDescription
indexint
builderForValueHistogramQueryResult.Builder
Returns
TypeDescription
SearchDocumentsResponse.Builder

addHistogramQueryResultsBuilder()

public HistogramQueryResult.Builder addHistogramQueryResultsBuilder()

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Returns
TypeDescription
HistogramQueryResult.Builder

addHistogramQueryResultsBuilder(int index)

public HistogramQueryResult.Builder addHistogramQueryResultsBuilder(int index)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
HistogramQueryResult.Builder

addMatchingDocuments(SearchDocumentsResponse.MatchingDocument value)

public SearchDocumentsResponse.Builder addMatchingDocuments(SearchDocumentsResponse.MatchingDocument value)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameter
NameDescription
valueSearchDocumentsResponse.MatchingDocument
Returns
TypeDescription
SearchDocumentsResponse.Builder

addMatchingDocuments(SearchDocumentsResponse.MatchingDocument.Builder builderForValue)

public SearchDocumentsResponse.Builder addMatchingDocuments(SearchDocumentsResponse.MatchingDocument.Builder builderForValue)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameter
NameDescription
builderForValueSearchDocumentsResponse.MatchingDocument.Builder
Returns
TypeDescription
SearchDocumentsResponse.Builder

addMatchingDocuments(int index, SearchDocumentsResponse.MatchingDocument value)

public SearchDocumentsResponse.Builder addMatchingDocuments(int index, SearchDocumentsResponse.MatchingDocument value)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameters
NameDescription
indexint
valueSearchDocumentsResponse.MatchingDocument
Returns
TypeDescription
SearchDocumentsResponse.Builder

addMatchingDocuments(int index, SearchDocumentsResponse.MatchingDocument.Builder builderForValue)

public SearchDocumentsResponse.Builder addMatchingDocuments(int index, SearchDocumentsResponse.MatchingDocument.Builder builderForValue)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameters
NameDescription
indexint
builderForValueSearchDocumentsResponse.MatchingDocument.Builder
Returns
TypeDescription
SearchDocumentsResponse.Builder

addMatchingDocumentsBuilder()

public SearchDocumentsResponse.MatchingDocument.Builder addMatchingDocumentsBuilder()

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument.Builder

addMatchingDocumentsBuilder(int index)

public SearchDocumentsResponse.MatchingDocument.Builder addMatchingDocumentsBuilder(int index)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchDocumentsResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchDocumentsResponse.Builder
Overrides

build()

public SearchDocumentsResponse build()
Returns
TypeDescription
SearchDocumentsResponse

buildPartial()

public SearchDocumentsResponse buildPartial()
Returns
TypeDescription
SearchDocumentsResponse

clear()

public SearchDocumentsResponse.Builder clear()
Returns
TypeDescription
SearchDocumentsResponse.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchDocumentsResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchDocumentsResponse.Builder
Overrides

clearHistogramQueryResults()

public SearchDocumentsResponse.Builder clearHistogramQueryResults()

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Returns
TypeDescription
SearchDocumentsResponse.Builder

clearMatchingDocuments()

public SearchDocumentsResponse.Builder clearMatchingDocuments()

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Returns
TypeDescription
SearchDocumentsResponse.Builder

clearMetadata()

public SearchDocumentsResponse.Builder clearMetadata()

Additional information for the API invocation, such as the request tracking id.

.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

Returns
TypeDescription
SearchDocumentsResponse.Builder

clearNextPageToken()

public SearchDocumentsResponse.Builder clearNextPageToken()

The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

string next_page_token = 2;

Returns
TypeDescription
SearchDocumentsResponse.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchDocumentsResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchDocumentsResponse.Builder
Overrides

clearQuestionAnswer()

public SearchDocumentsResponse.Builder clearQuestionAnswer()

Experimental. Question answer from the query against the document.

string question_answer = 7;

Returns
TypeDescription
SearchDocumentsResponse.Builder

This builder for chaining.

clearTotalSize()

public SearchDocumentsResponse.Builder clearTotalSize()

The total number of matched documents which is available only if the client set SearchDocumentsRequest.require_total_size to true or set SearchDocumentsRequest.total_result_size to ESTIMATED_SIZE or ACTUAL_SIZE. Otherwise, the value will be -1. Typically a UI would handle this condition by displaying &quot;of many&quot;, for example: &quot;Displaying 10 of many&quot;.

int32 total_size = 3;

Returns
TypeDescription
SearchDocumentsResponse.Builder

This builder for chaining.

clone()

public SearchDocumentsResponse.Builder clone()
Returns
TypeDescription
SearchDocumentsResponse.Builder
Overrides

getDefaultInstanceForType()

public SearchDocumentsResponse getDefaultInstanceForType()
Returns
TypeDescription
SearchDocumentsResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getHistogramQueryResults(int index)

public HistogramQueryResult getHistogramQueryResults(int index)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
HistogramQueryResult

getHistogramQueryResultsBuilder(int index)

public HistogramQueryResult.Builder getHistogramQueryResultsBuilder(int index)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
HistogramQueryResult.Builder

getHistogramQueryResultsBuilderList()

public List<HistogramQueryResult.Builder> getHistogramQueryResultsBuilderList()

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Returns
TypeDescription
List<Builder>

getHistogramQueryResultsCount()

public int getHistogramQueryResultsCount()

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Returns
TypeDescription
int

getHistogramQueryResultsList()

public List<HistogramQueryResult> getHistogramQueryResultsList()

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Returns
TypeDescription
List<HistogramQueryResult>

getHistogramQueryResultsOrBuilder(int index)

public HistogramQueryResultOrBuilder getHistogramQueryResultsOrBuilder(int index)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
HistogramQueryResultOrBuilder

getHistogramQueryResultsOrBuilderList()

public List<? extends HistogramQueryResultOrBuilder> getHistogramQueryResultsOrBuilderList()

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Returns
TypeDescription
List<? extends com.google.cloud.contentwarehouse.v1.HistogramQueryResultOrBuilder>

getMatchingDocuments(int index)

public SearchDocumentsResponse.MatchingDocument getMatchingDocuments(int index)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument

getMatchingDocumentsBuilder(int index)

public SearchDocumentsResponse.MatchingDocument.Builder getMatchingDocumentsBuilder(int index)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocument.Builder

getMatchingDocumentsBuilderList()

public List<SearchDocumentsResponse.MatchingDocument.Builder> getMatchingDocumentsBuilderList()

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Returns
TypeDescription
List<Builder>

getMatchingDocumentsCount()

public int getMatchingDocumentsCount()

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Returns
TypeDescription
int

getMatchingDocumentsList()

public List<SearchDocumentsResponse.MatchingDocument> getMatchingDocumentsList()

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Returns
TypeDescription
List<MatchingDocument>

getMatchingDocumentsOrBuilder(int index)

public SearchDocumentsResponse.MatchingDocumentOrBuilder getMatchingDocumentsOrBuilder(int index)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchDocumentsResponse.MatchingDocumentOrBuilder

getMatchingDocumentsOrBuilderList()

public List<? extends SearchDocumentsResponse.MatchingDocumentOrBuilder> getMatchingDocumentsOrBuilderList()

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Returns
TypeDescription
List<? extends com.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocumentOrBuilder>

getMetadata()

public ResponseMetadata getMetadata()

Additional information for the API invocation, such as the request tracking id.

.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

Returns
TypeDescription
ResponseMetadata

The metadata.

getMetadataBuilder()

public ResponseMetadata.Builder getMetadataBuilder()

Additional information for the API invocation, such as the request tracking id.

.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

Returns
TypeDescription
ResponseMetadata.Builder

getMetadataOrBuilder()

public ResponseMetadataOrBuilder getMetadataOrBuilder()

Additional information for the API invocation, such as the request tracking id.

.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

Returns
TypeDescription
ResponseMetadataOrBuilder

getNextPageToken()

public String getNextPageToken()

The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

string next_page_token = 2;

Returns
TypeDescription
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

string next_page_token = 2;

Returns
TypeDescription
ByteString

The bytes for nextPageToken.

getQuestionAnswer()

public String getQuestionAnswer()

Experimental. Question answer from the query against the document.

string question_answer = 7;

Returns
TypeDescription
String

The questionAnswer.

getQuestionAnswerBytes()

public ByteString getQuestionAnswerBytes()

Experimental. Question answer from the query against the document.

string question_answer = 7;

Returns
TypeDescription
ByteString

The bytes for questionAnswer.

getTotalSize()

public int getTotalSize()

The total number of matched documents which is available only if the client set SearchDocumentsRequest.require_total_size to true or set SearchDocumentsRequest.total_result_size to ESTIMATED_SIZE or ACTUAL_SIZE. Otherwise, the value will be -1. Typically a UI would handle this condition by displaying &quot;of many&quot;, for example: &quot;Displaying 10 of many&quot;.

int32 total_size = 3;

Returns
TypeDescription
int

The totalSize.

hasMetadata()

public boolean hasMetadata()

Additional information for the API invocation, such as the request tracking id.

.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

Returns
TypeDescription
boolean

Whether the metadata field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchDocumentsResponse other)

public SearchDocumentsResponse.Builder mergeFrom(SearchDocumentsResponse other)
Parameter
NameDescription
otherSearchDocumentsResponse
Returns
TypeDescription
SearchDocumentsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchDocumentsResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDocumentsResponse.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchDocumentsResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchDocumentsResponse.Builder
Overrides

mergeMetadata(ResponseMetadata value)

public SearchDocumentsResponse.Builder mergeMetadata(ResponseMetadata value)

Additional information for the API invocation, such as the request tracking id.

.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

Parameter
NameDescription
valueResponseMetadata
Returns
TypeDescription
SearchDocumentsResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchDocumentsResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchDocumentsResponse.Builder
Overrides

removeHistogramQueryResults(int index)

public SearchDocumentsResponse.Builder removeHistogramQueryResults(int index)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchDocumentsResponse.Builder

removeMatchingDocuments(int index)

public SearchDocumentsResponse.Builder removeMatchingDocuments(int index)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchDocumentsResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SearchDocumentsResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchDocumentsResponse.Builder
Overrides

setHistogramQueryResults(int index, HistogramQueryResult value)

public SearchDocumentsResponse.Builder setHistogramQueryResults(int index, HistogramQueryResult value)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameters
NameDescription
indexint
valueHistogramQueryResult
Returns
TypeDescription
SearchDocumentsResponse.Builder

setHistogramQueryResults(int index, HistogramQueryResult.Builder builderForValue)

public SearchDocumentsResponse.Builder setHistogramQueryResults(int index, HistogramQueryResult.Builder builderForValue)

The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.

repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

Parameters
NameDescription
indexint
builderForValueHistogramQueryResult.Builder
Returns
TypeDescription
SearchDocumentsResponse.Builder

setMatchingDocuments(int index, SearchDocumentsResponse.MatchingDocument value)

public SearchDocumentsResponse.Builder setMatchingDocuments(int index, SearchDocumentsResponse.MatchingDocument value)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameters
NameDescription
indexint
valueSearchDocumentsResponse.MatchingDocument
Returns
TypeDescription
SearchDocumentsResponse.Builder

setMatchingDocuments(int index, SearchDocumentsResponse.MatchingDocument.Builder builderForValue)

public SearchDocumentsResponse.Builder setMatchingDocuments(int index, SearchDocumentsResponse.MatchingDocument.Builder builderForValue)

The document entities that match the specified SearchDocumentsRequest.

repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

Parameters
NameDescription
indexint
builderForValueSearchDocumentsResponse.MatchingDocument.Builder
Returns
TypeDescription
SearchDocumentsResponse.Builder

setMetadata(ResponseMetadata value)

public SearchDocumentsResponse.Builder setMetadata(ResponseMetadata value)

Additional information for the API invocation, such as the request tracking id.

.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

Parameter
NameDescription
valueResponseMetadata
Returns
TypeDescription
SearchDocumentsResponse.Builder

setMetadata(ResponseMetadata.Builder builderForValue)

public SearchDocumentsResponse.Builder setMetadata(ResponseMetadata.Builder builderForValue)

Additional information for the API invocation, such as the request tracking id.

.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

Parameter
NameDescription
builderForValueResponseMetadata.Builder
Returns
TypeDescription
SearchDocumentsResponse.Builder

setNextPageToken(String value)

public SearchDocumentsResponse.Builder setNextPageToken(String value)

The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

string next_page_token = 2;

Parameter
NameDescription
valueString

The nextPageToken to set.

Returns
TypeDescription
SearchDocumentsResponse.Builder

This builder for chaining.

setNextPageTokenBytes(ByteString value)

public SearchDocumentsResponse.Builder setNextPageTokenBytes(ByteString value)

The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

string next_page_token = 2;

Parameter
NameDescription
valueByteString

The bytes for nextPageToken to set.

Returns
TypeDescription
SearchDocumentsResponse.Builder

This builder for chaining.

setQuestionAnswer(String value)

public SearchDocumentsResponse.Builder setQuestionAnswer(String value)

Experimental. Question answer from the query against the document.

string question_answer = 7;

Parameter
NameDescription
valueString

The questionAnswer to set.

Returns
TypeDescription
SearchDocumentsResponse.Builder

This builder for chaining.

setQuestionAnswerBytes(ByteString value)

public SearchDocumentsResponse.Builder setQuestionAnswerBytes(ByteString value)

Experimental. Question answer from the query against the document.

string question_answer = 7;

Parameter
NameDescription
valueByteString

The bytes for questionAnswer to set.

Returns
TypeDescription
SearchDocumentsResponse.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchDocumentsResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchDocumentsResponse.Builder
Overrides

setTotalSize(int value)

public SearchDocumentsResponse.Builder setTotalSize(int value)

The total number of matched documents which is available only if the client set SearchDocumentsRequest.require_total_size to true or set SearchDocumentsRequest.total_result_size to ESTIMATED_SIZE or ACTUAL_SIZE. Otherwise, the value will be -1. Typically a UI would handle this condition by displaying &quot;of many&quot;, for example: &quot;Displaying 10 of many&quot;.

int32 total_size = 3;

Parameter
NameDescription
valueint

The totalSize to set.

Returns
TypeDescription
SearchDocumentsResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchDocumentsResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchDocumentsResponse.Builder
Overrides