Package com.google.cloud.contentwarehouse.v1

Class SearchDocumentsResponse.MatchingDocument

    • Field Detail

      • SEARCH_TEXT_SNIPPET_FIELD_NUMBER

        public static final int SEARCH_TEXT_SNIPPET_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

      • hasDocument

        public boolean hasDocument()
         Document that matches the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
 This document only contains indexed metadata information.
        .google.cloud.contentwarehouse.v1.Document document = 1;
        Specified by:
        hasDocument in interface SearchDocumentsResponse.MatchingDocumentOrBuilder
        Returns:
        Whether the document field is set.

      • getDocument

        public Document getDocument()
         Document that matches the specified
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
 This document only contains indexed metadata information.
        .google.cloud.contentwarehouse.v1.Document document = 1;
        Specified by:
        getDocument in interface SearchDocumentsResponse.MatchingDocumentOrBuilder
        Returns:
        The document.

      • getSearchTextSnippet

        public String getSearchTextSnippet()
         Contains snippets of text from the document full raw text that most
 closely match a search query's keywords, if available. All HTML tags in
 the original fields are stripped when returned in this field, and
 matching query keywords are enclosed in HTML bold tags.

 If the question-answering feature is enabled, this field will instead
 contain a snippet that answers the user's natural-language query. No HTML
 bold tags will be present, and highlights in the answer snippet can be
 found in
 [QAResult.highlights][google.cloud.contentwarehouse.v1.QAResult.highlights].
        string search_text_snippet = 2;
        Specified by:
        getSearchTextSnippet in interface SearchDocumentsResponse.MatchingDocumentOrBuilder
        Returns:
        The searchTextSnippet.

      • getSearchTextSnippetBytes

        public com.google.protobuf.ByteString getSearchTextSnippetBytes()
         Contains snippets of text from the document full raw text that most
 closely match a search query's keywords, if available. All HTML tags in
 the original fields are stripped when returned in this field, and
 matching query keywords are enclosed in HTML bold tags.

 If the question-answering feature is enabled, this field will instead
 contain a snippet that answers the user's natural-language query. No HTML
 bold tags will be present, and highlights in the answer snippet can be
 found in
 [QAResult.highlights][google.cloud.contentwarehouse.v1.QAResult.highlights].
        string search_text_snippet = 2;
        Specified by:
        getSearchTextSnippetBytes in interface SearchDocumentsResponse.MatchingDocumentOrBuilder
        Returns:
        The bytes for searchTextSnippet.

      • hasQaResult

        public boolean hasQaResult()
         Experimental.
 Additional result info if the question-answering feature is enabled.
        .google.cloud.contentwarehouse.v1.QAResult qa_result = 3;
        Specified by:
        hasQaResult in interface SearchDocumentsResponse.MatchingDocumentOrBuilder
        Returns:
        Whether the qaResult field is set.

      • 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.MatchingDocument parseFrom​(ByteBuffer data,
                                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static SearchDocumentsResponse.MatchingDocument 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.MatchingDocument parseFrom​(byte[] data)
                                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<SearchDocumentsResponse.MatchingDocument> 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.MatchingDocument getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder