Package com.google.cloud.contentwarehouse.v1

Class SearchDocumentsResponse.MatchingDocument.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.MatchingDocument.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.MatchingDocument.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

        public SearchDocumentsResponse.MatchingDocument buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.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.MatchingDocument.Builder>

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

      • setDocument

        public SearchDocumentsResponse.MatchingDocument.Builder setDocument​(Document value)
         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;

      • setDocument

        public SearchDocumentsResponse.MatchingDocument.Builder setDocument​(Document.Builder builderForValue)
         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;

      • mergeDocument

        public SearchDocumentsResponse.MatchingDocument.Builder mergeDocument​(Document value)
         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;

      • clearDocument

        public SearchDocumentsResponse.MatchingDocument.Builder clearDocument()
         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;

      • getDocumentBuilder

        public Document.Builder getDocumentBuilder()
         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;

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

      • setSearchTextSnippet

        public SearchDocumentsResponse.MatchingDocument.Builder setSearchTextSnippet​(String value)
         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;
        Parameters:
        value - The searchTextSnippet to set.
        Returns:
        This builder for chaining.

      • clearSearchTextSnippet

        public SearchDocumentsResponse.MatchingDocument.Builder clearSearchTextSnippet()
         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;
        Returns:
        This builder for chaining.

      • setSearchTextSnippetBytes

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

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

      • getQaResultBuilder

        public QAResult.Builder getQaResultBuilder()
         Experimental.
 Additional result info if the question-answering feature is enabled.
        .google.cloud.contentwarehouse.v1.QAResult qa_result = 3;