Package com.google.cloud.contentwarehouse.v1

Interface SearchDocumentsResponseOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SearchDocumentsResponse, SearchDocumentsResponse.Builder
    public interface SearchDocumentsResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getMatchingDocumentsList

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

      • getMatchingDocuments

        SearchDocumentsResponse.MatchingDocument getMatchingDocuments​(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;

      • getMatchingDocumentsCount

        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;

      • getMatchingDocumentsOrBuilderList

        List<? extends SearchDocumentsResponse.MatchingDocumentOrBuilder> getMatchingDocumentsOrBuilderList()
         The document entities that match the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
        repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;

      • getMatchingDocumentsOrBuilder

        SearchDocumentsResponse.MatchingDocumentOrBuilder getMatchingDocumentsOrBuilder​(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;

      • getNextPageToken

        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:
        The nextPageToken.

      • getNextPageTokenBytes

        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;
        Returns:
        The bytes for nextPageToken.

      • getTotalSize

        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;
        Returns:
        The totalSize.

      • hasMetadata

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

      • getMetadata

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

      • getMetadataOrBuilder

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

      • getHistogramQueryResultsList

        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;

      • getHistogramQueryResults

        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;

      • getHistogramQueryResultsCount

        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;

      • getHistogramQueryResultsOrBuilderList

        List<? extends HistogramQueryResultOrBuilder> getHistogramQueryResultsOrBuilderList()
         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

        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;

      • getQuestionAnswer

        String getQuestionAnswer()
         Experimental.
 Question answer from the query against the document.
        string question_answer = 7;
        Returns:
        The questionAnswer.

      • getQuestionAnswerBytes

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