Class SearchDocumentsResponse.Builder (0.17.0)

Version 0.17.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchDocumentsResponse.Builder

Implements

SearchDocumentsResponseOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
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
Name	Description
values	Iterable<? extends com.google.cloud.contentwarehouse.v1.HistogramQueryResult>

Returns
Type	Description
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
Name	Description
values	Iterable<? extends com.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument>

Returns
Type	Description
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
Name	Description
value	HistogramQueryResult

Returns
Type	Description
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
Name	Description
builderForValue	HistogramQueryResult.Builder

Returns
Type	Description
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
Name	Description
index	int
value	HistogramQueryResult

Returns
Type	Description
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
Name	Description
index	int
builderForValue	HistogramQueryResult.Builder

Returns
Type	Description
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
Type	Description
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
Name	Description
index	int

Returns
Type	Description
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
Name	Description
value	SearchDocumentsResponse.MatchingDocument

Returns
Type	Description
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
Name	Description
builderForValue	SearchDocumentsResponse.MatchingDocument.Builder

Returns
Type	Description
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
Name	Description
index	int
value	SearchDocumentsResponse.MatchingDocument

Returns
Type	Description
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
Name	Description
index	int
builderForValue	SearchDocumentsResponse.MatchingDocument.Builder

Returns
Type	Description
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
Type	Description
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
Name	Description
index	int

Returns
Type	Description
SearchDocumentsResponse.MatchingDocument.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchDocumentsResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SearchDocumentsResponse build()

Returns
Type	Description
SearchDocumentsResponse

buildPartial()

public SearchDocumentsResponse buildPartial()

Returns
Type	Description
SearchDocumentsResponse

clear()

public SearchDocumentsResponse.Builder clear()

Returns
Type	Description
SearchDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchDocumentsResponse.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SearchDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
SearchDocumentsResponse.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchDocumentsResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SearchDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
SearchDocumentsResponse.Builder	This builder for chaining.

clone()

public SearchDocumentsResponse.Builder clone()

Returns
Type	Description
SearchDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchDocumentsResponse getDefaultInstanceForType()

Returns
Type	Description
SearchDocumentsResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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
Name	Description
index	int

Returns
Type	Description
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
Name	Description
index	int

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Name	Description
index	int

Returns
Type	Description
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
Type	Description
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
Name	Description
index	int

Returns
Type	Description
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
Name	Description
index	int

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Name	Description
index	int

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
ByteString	The bytes for nextPageToken.

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
Type	Description
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
Type	Description
boolean	Whether the metadata field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchDocumentsResponse other)

public SearchDocumentsResponse.Builder mergeFrom(SearchDocumentsResponse other)

Parameter
Name	Description
other	SearchDocumentsResponse

Returns
Type	Description
SearchDocumentsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchDocumentsResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchDocumentsResponse.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchDocumentsResponse.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchDocumentsResponse.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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
Name	Description
value	ResponseMetadata

Returns
Type	Description
SearchDocumentsResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchDocumentsResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
index	int

Returns
Type	Description
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
Name	Description
index	int

Returns
Type	Description
SearchDocumentsResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SearchDocumentsResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
Name	Description
index	int
value	HistogramQueryResult

Returns
Type	Description
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
Name	Description
index	int
builderForValue	HistogramQueryResult.Builder

Returns
Type	Description
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
Name	Description
index	int
value	SearchDocumentsResponse.MatchingDocument

Returns
Type	Description
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
Name	Description
index	int
builderForValue	SearchDocumentsResponse.MatchingDocument.Builder

Returns
Type	Description
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
Name	Description
value	ResponseMetadata

Returns
Type	Description
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
Name	Description
builderForValue	ResponseMetadata.Builder

Returns
Type	Description
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
Name	Description
value	String The nextPageToken to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for nextPageToken to set.

Returns
Type	Description
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
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SearchDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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
Name	Description
value	int The totalSize to set.

Returns
Type	Description
SearchDocumentsResponse.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchDocumentsResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)