Package com.google.cloud.contentwarehouse.v1

Class SearchDocumentsResponse

  • All Implemented Interfaces:
    SearchDocumentsResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SearchDocumentsResponse
extends com.google.protobuf.GeneratedMessageV3
implements SearchDocumentsResponseOrBuilder
     Response message for DocumentService.SearchDocuments.
    Protobuf type google.cloud.contentwarehouse.v1.SearchDocumentsResponse
    See Also:
    Serialized Form

    • Field Detail

      • MATCHING_DOCUMENTS_FIELD_NUMBER

        public static final int MATCHING_DOCUMENTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NEXT_PAGE_TOKEN_FIELD_NUMBER

        public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_SIZE_FIELD_NUMBER

        public static final int TOTAL_SIZE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HISTOGRAM_QUERY_RESULTS_FIELD_NUMBER

        public static final int HISTOGRAM_QUERY_RESULTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • QUESTION_ANSWER_FIELD_NUMBER

        public static final int QUESTION_ANSWER_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • 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

      • 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.

      • 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 "of
 many", for example: "Displaying 10 of many".
        int32 total_size = 3;
        Specified by:
        getTotalSize in interface SearchDocumentsResponseOrBuilder
        Returns:
        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;
        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.

      • 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

      • 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

      • 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.

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static SearchDocumentsResponse parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchDocumentsResponse parseFrom​(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchDocumentsResponse parseFrom​(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchDocumentsResponse parseFrom​(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchDocumentsResponse parseFrom​(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchDocumentsResponse parseFrom​(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected SearchDocumentsResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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

      • getDefaultInstanceForType

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