Package com.google.cloud.contentwarehouse.v1

Class SearchDocumentsResponse.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder>

      • clear

        public SearchDocumentsResponse.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder>

      • getDefaultInstanceForType

        public SearchDocumentsResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public SearchDocumentsResponse build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public SearchDocumentsResponse buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public SearchDocumentsResponse.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder>

      • clearField

        public SearchDocumentsResponse.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder>

      • clearOneof

        public SearchDocumentsResponse.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder>

      • setRepeatedField

        public SearchDocumentsResponse.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        int index,
                                                        Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder>

      • addRepeatedField

        public SearchDocumentsResponse.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder>

      • mergeFrom

        public SearchDocumentsResponse.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchDocumentsResponse.Builder>
        Throws:
        IOException

      • getMatchingDocumentsCount

        public int getMatchingDocumentsCount()
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
        Specified by:
        getMatchingDocumentsCount in interface SearchDocumentsResponseOrBuilder

      • setMatchingDocuments

        public SearchDocumentsResponse.Builder setMatchingDocuments​(int index,
                                                            SearchDocumentsResponse.MatchingDocument value)
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • setMatchingDocuments

        public SearchDocumentsResponse.Builder setMatchingDocuments​(int index,
                                                            SearchDocumentsResponse.MatchingDocument.Builder builderForValue)
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • addMatchingDocuments

        public SearchDocumentsResponse.Builder addMatchingDocuments​(SearchDocumentsResponse.MatchingDocument value)
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • addMatchingDocuments

        public SearchDocumentsResponse.Builder addMatchingDocuments​(int index,
                                                            SearchDocumentsResponse.MatchingDocument value)
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • addMatchingDocuments

        public SearchDocumentsResponse.Builder addMatchingDocuments​(int index,
                                                            SearchDocumentsResponse.MatchingDocument.Builder builderForValue)
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • addAllMatchingDocuments

        public SearchDocumentsResponse.Builder addAllMatchingDocuments​(Iterable<? extends SearchDocumentsResponse.MatchingDocument> values)
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • clearMatchingDocuments

        public SearchDocumentsResponse.Builder clearMatchingDocuments()
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • removeMatchingDocuments

        public SearchDocumentsResponse.Builder removeMatchingDocuments​(int index)
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • getMatchingDocumentsBuilder

        public SearchDocumentsResponse.MatchingDocument.Builder getMatchingDocumentsBuilder​(int index)
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • addMatchingDocumentsBuilder

        public SearchDocumentsResponse.MatchingDocument.Builder addMatchingDocumentsBuilder()
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • addMatchingDocumentsBuilder

        public SearchDocumentsResponse.MatchingDocument.Builder addMatchingDocumentsBuilder​(int index)
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • getMatchingDocumentsBuilderList

        public List<SearchDocumentsResponse.MatchingDocument.Builder> getMatchingDocumentsBuilderList()
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • 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;
        Specified by:
        getNextPageToken in interface SearchDocumentsResponseOrBuilder
        Returns:
        The nextPageToken.

      • getNextPageTokenBytes

        public com.google.protobuf.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;
        Specified by:
        getNextPageTokenBytes in interface SearchDocumentsResponseOrBuilder
        Returns:
        The bytes for nextPageToken.

      • setNextPageToken

        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;
        Parameters:
        value - The nextPageToken to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • setNextPageTokenBytes

        public SearchDocumentsResponse.Builder setNextPageTokenBytes​(com.google.protobuf.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;
        Parameters:
        value - The bytes for nextPageToken to set.
        Returns:
        This builder for chaining.

      • getTotalSize

        public int getTotalSize()
         The total number of matched documents which is available only if the client
 set
 [SearchDocumentsRequest.require_total_size][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.require_total_size]
 to `true` or set
 [SearchDocumentsRequest.total_result_size][google.cloud.contentwarehouse.v1.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;
        Specified by:
        getTotalSize in interface SearchDocumentsResponseOrBuilder
        Returns:
        The totalSize.

      • setTotalSize

        public SearchDocumentsResponse.Builder setTotalSize​(int value)
         The total number of matched documents which is available only if the client
 set
 [SearchDocumentsRequest.require_total_size][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.require_total_size]
 to `true` or set
 [SearchDocumentsRequest.total_result_size][google.cloud.contentwarehouse.v1.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;
        Parameters:
        value - The totalSize to set.
        Returns:
        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][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.require_total_size]
 to `true` or set
 [SearchDocumentsRequest.total_result_size][google.cloud.contentwarehouse.v1.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:
        This builder for chaining.

      • hasMetadata

        public boolean hasMetadata()
         Additional information for the API invocation, such as the request tracking
 id.
        .google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;
        Specified by:
        hasMetadata in interface SearchDocumentsResponseOrBuilder
        Returns:
        Whether the metadata field is set.

      • getMetadata

        public ResponseMetadata getMetadata()
         Additional information for the API invocation, such as the request tracking
 id.
        .google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;
        Specified by:
        getMetadata in interface SearchDocumentsResponseOrBuilder
        Returns:
        The metadata.

      • setMetadata

        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;

      • mergeMetadata

        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;

      • clearMetadata

        public SearchDocumentsResponse.Builder clearMetadata()
         Additional information for the API invocation, such as the request tracking
 id.
        .google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

      • getMetadataBuilder

        public ResponseMetadata.Builder getMetadataBuilder()
         Additional information for the API invocation, such as the request tracking
 id.
        .google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;

      • getHistogramQueryResultsList

        public List<HistogramQueryResult> getHistogramQueryResultsList()
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
        Specified by:
        getHistogramQueryResultsList in interface SearchDocumentsResponseOrBuilder

      • getHistogramQueryResultsCount

        public int getHistogramQueryResultsCount()
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
        Specified by:
        getHistogramQueryResultsCount in interface SearchDocumentsResponseOrBuilder

      • getHistogramQueryResults

        public HistogramQueryResult getHistogramQueryResults​(int index)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
        Specified by:
        getHistogramQueryResults in interface SearchDocumentsResponseOrBuilder

      • setHistogramQueryResults

        public SearchDocumentsResponse.Builder setHistogramQueryResults​(int index,
                                                                HistogramQueryResult value)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • setHistogramQueryResults

        public SearchDocumentsResponse.Builder setHistogramQueryResults​(int index,
                                                                HistogramQueryResult.Builder builderForValue)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • addHistogramQueryResults

        public SearchDocumentsResponse.Builder addHistogramQueryResults​(HistogramQueryResult value)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • addHistogramQueryResults

        public SearchDocumentsResponse.Builder addHistogramQueryResults​(int index,
                                                                HistogramQueryResult value)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • addHistogramQueryResults

        public SearchDocumentsResponse.Builder addHistogramQueryResults​(HistogramQueryResult.Builder builderForValue)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • addHistogramQueryResults

        public SearchDocumentsResponse.Builder addHistogramQueryResults​(int index,
                                                                HistogramQueryResult.Builder builderForValue)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • addAllHistogramQueryResults

        public SearchDocumentsResponse.Builder addAllHistogramQueryResults​(Iterable<? extends HistogramQueryResult> values)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • clearHistogramQueryResults

        public SearchDocumentsResponse.Builder clearHistogramQueryResults()
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • removeHistogramQueryResults

        public SearchDocumentsResponse.Builder removeHistogramQueryResults​(int index)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • getHistogramQueryResultsBuilder

        public HistogramQueryResult.Builder getHistogramQueryResultsBuilder​(int index)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • getHistogramQueryResultsOrBuilder

        public HistogramQueryResultOrBuilder getHistogramQueryResultsOrBuilder​(int index)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
        Specified by:
        getHistogramQueryResultsOrBuilder in interface SearchDocumentsResponseOrBuilder

      • addHistogramQueryResultsBuilder

        public HistogramQueryResult.Builder addHistogramQueryResultsBuilder()
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • addHistogramQueryResultsBuilder

        public HistogramQueryResult.Builder addHistogramQueryResultsBuilder​(int index)
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • getHistogramQueryResultsBuilderList

        public List<HistogramQueryResult.Builder> getHistogramQueryResultsBuilderList()
         The histogram results that match with the specified
 [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
        repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;

      • getQuestionAnswerBytes

        public com.google.protobuf.ByteString getQuestionAnswerBytes()
         Experimental.
 Question answer from the query against the document.
        string question_answer = 7;
        Specified by:
        getQuestionAnswerBytes in interface SearchDocumentsResponseOrBuilder
        Returns:
        The bytes for questionAnswer.

      • setQuestionAnswer

        public SearchDocumentsResponse.Builder setQuestionAnswer​(String value)
         Experimental.
 Question answer from the query against the document.
        string question_answer = 7;
        Parameters:
        value - The questionAnswer to set.
        Returns:
        This builder for chaining.

      • clearQuestionAnswer

        public SearchDocumentsResponse.Builder clearQuestionAnswer()
         Experimental.
 Question answer from the query against the document.
        string question_answer = 7;
        Returns:
        This builder for chaining.

      • setQuestionAnswerBytes

        public SearchDocumentsResponse.Builder setQuestionAnswerBytes​(com.google.protobuf.ByteString value)
         Experimental.
 Question answer from the query against the document.
        string question_answer = 7;
        Parameters:
        value - The bytes for questionAnswer to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final SearchDocumentsResponse.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder>

      • mergeUnknownFields

        public final SearchDocumentsResponse.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchDocumentsResponse.Builder>