Package com.google.cloud.discoveryengine.v1

Class SearchResponse.Builder

  • All Implemented Interfaces:
    SearchResponseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    SearchResponse
    public static final class SearchResponse.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
implements SearchResponseOrBuilder
     Response message for
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 method.
    Protobuf type google.cloud.discoveryengine.v1.SearchResponse

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

      • clear

        public SearchResponse.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<SearchResponse.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<SearchResponse.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public SearchResponse.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<SearchResponse.Builder>

      • setField

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

      • clearField

        public SearchResponse.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<SearchResponse.Builder>

      • clearOneof

        public SearchResponse.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<SearchResponse.Builder>

      • setRepeatedField

        public SearchResponse.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<SearchResponse.Builder>

      • addRepeatedField

        public SearchResponse.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<SearchResponse.Builder>

      • mergeFrom

        public SearchResponse.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResponse.Builder>

      • isInitialized

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

      • mergeFrom

        public SearchResponse.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<SearchResponse.Builder>
        Throws:
        IOException

      • getResultsCount

        public int getResultsCount()
         A list of matched documents. The order represents the ranking.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
        Specified by:
        getResultsCount in interface SearchResponseOrBuilder

      • setResults

        public SearchResponse.Builder setResults​(int index,
                                         SearchResponse.SearchResult value)
         A list of matched documents. The order represents the ranking.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

      • addResults

        public SearchResponse.Builder addResults​(int index,
                                         SearchResponse.SearchResult value)
         A list of matched documents. The order represents the ranking.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

      • clearResults

        public SearchResponse.Builder clearResults()
         A list of matched documents. The order represents the ranking.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

      • removeResults

        public SearchResponse.Builder removeResults​(int index)
         A list of matched documents. The order represents the ranking.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

      • getResultsBuilder

        public SearchResponse.SearchResult.Builder getResultsBuilder​(int index)
         A list of matched documents. The order represents the ranking.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

      • addResultsBuilder

        public SearchResponse.SearchResult.Builder addResultsBuilder()
         A list of matched documents. The order represents the ranking.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

      • addResultsBuilder

        public SearchResponse.SearchResult.Builder addResultsBuilder​(int index)
         A list of matched documents. The order represents the ranking.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

      • getResultsBuilderList

        public List<SearchResponse.SearchResult.Builder> getResultsBuilderList()
         A list of matched documents. The order represents the ranking.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

      • getFacetsCount

        public int getFacetsCount()
         Results of facets requested by user.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;
        Specified by:
        getFacetsCount in interface SearchResponseOrBuilder

      • clearFacets

        public SearchResponse.Builder clearFacets()
         Results of facets requested by user.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

      • removeFacets

        public SearchResponse.Builder removeFacets​(int index)
         Results of facets requested by user.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

      • getFacetsBuilder

        public SearchResponse.Facet.Builder getFacetsBuilder​(int index)
         Results of facets requested by user.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

      • addFacetsBuilder

        public SearchResponse.Facet.Builder addFacetsBuilder()
         Results of facets requested by user.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

      • addFacetsBuilder

        public SearchResponse.Facet.Builder addFacetsBuilder​(int index)
         Results of facets requested by user.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

      • getFacetsBuilderList

        public List<SearchResponse.Facet.Builder> getFacetsBuilderList()
         Results of facets requested by user.
        repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

      • getTotalSize

        public int getTotalSize()
         The estimated total count of matched items irrespective of pagination. The
 count of [results][google.cloud.discoveryengine.v1.SearchResponse.results]
 returned by pagination may be less than the
 [total_size][google.cloud.discoveryengine.v1.SearchResponse.total_size]
 that matches.
        int32 total_size = 3;
        Specified by:
        getTotalSize in interface SearchResponseOrBuilder
        Returns:
        The totalSize.

      • setTotalSize

        public SearchResponse.Builder setTotalSize​(int value)
         The estimated total count of matched items irrespective of pagination. The
 count of [results][google.cloud.discoveryengine.v1.SearchResponse.results]
 returned by pagination may be less than the
 [total_size][google.cloud.discoveryengine.v1.SearchResponse.total_size]
 that matches.
        int32 total_size = 3;
        Parameters:
        value - The totalSize to set.
        Returns:
        This builder for chaining.

      • clearTotalSize

        public SearchResponse.Builder clearTotalSize()
         The estimated total count of matched items irrespective of pagination. The
 count of [results][google.cloud.discoveryengine.v1.SearchResponse.results]
 returned by pagination may be less than the
 [total_size][google.cloud.discoveryengine.v1.SearchResponse.total_size]
 that matches.
        int32 total_size = 3;
        Returns:
        This builder for chaining.

      • getAttributionToken

        public String getAttributionToken()
         A unique search token. This should be included in the
 [UserEvent][google.cloud.discoveryengine.v1.UserEvent] logs resulting from
 this search, which enables accurate attribution of search model
 performance.
        string attribution_token = 4;
        Specified by:
        getAttributionToken in interface SearchResponseOrBuilder
        Returns:
        The attributionToken.

      • getAttributionTokenBytes

        public com.google.protobuf.ByteString getAttributionTokenBytes()
         A unique search token. This should be included in the
 [UserEvent][google.cloud.discoveryengine.v1.UserEvent] logs resulting from
 this search, which enables accurate attribution of search model
 performance.
        string attribution_token = 4;
        Specified by:
        getAttributionTokenBytes in interface SearchResponseOrBuilder
        Returns:
        The bytes for attributionToken.

      • setAttributionToken

        public SearchResponse.Builder setAttributionToken​(String value)
         A unique search token. This should be included in the
 [UserEvent][google.cloud.discoveryengine.v1.UserEvent] logs resulting from
 this search, which enables accurate attribution of search model
 performance.
        string attribution_token = 4;
        Parameters:
        value - The attributionToken to set.
        Returns:
        This builder for chaining.

      • clearAttributionToken

        public SearchResponse.Builder clearAttributionToken()
         A unique search token. This should be included in the
 [UserEvent][google.cloud.discoveryengine.v1.UserEvent] logs resulting from
 this search, which enables accurate attribution of search model
 performance.
        string attribution_token = 4;
        Returns:
        This builder for chaining.

      • setAttributionTokenBytes

        public SearchResponse.Builder setAttributionTokenBytes​(com.google.protobuf.ByteString value)
         A unique search token. This should be included in the
 [UserEvent][google.cloud.discoveryengine.v1.UserEvent] logs resulting from
 this search, which enables accurate attribution of search model
 performance.
        string attribution_token = 4;
        Parameters:
        value - The bytes for attributionToken to set.
        Returns:
        This builder for chaining.

      • getRedirectUri

        public String getRedirectUri()
         The URI of a customer-defined redirect page. If redirect action is
 triggered, no search is performed, and only
 [redirect_uri][google.cloud.discoveryengine.v1.SearchResponse.redirect_uri]
 and
 [attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token]
 are set in the response.
        string redirect_uri = 12;
        Specified by:
        getRedirectUri in interface SearchResponseOrBuilder
        Returns:
        The redirectUri.

      • getRedirectUriBytes

        public com.google.protobuf.ByteString getRedirectUriBytes()
         The URI of a customer-defined redirect page. If redirect action is
 triggered, no search is performed, and only
 [redirect_uri][google.cloud.discoveryengine.v1.SearchResponse.redirect_uri]
 and
 [attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token]
 are set in the response.
        string redirect_uri = 12;
        Specified by:
        getRedirectUriBytes in interface SearchResponseOrBuilder
        Returns:
        The bytes for redirectUri.

      • setRedirectUri

        public SearchResponse.Builder setRedirectUri​(String value)
         The URI of a customer-defined redirect page. If redirect action is
 triggered, no search is performed, and only
 [redirect_uri][google.cloud.discoveryengine.v1.SearchResponse.redirect_uri]
 and
 [attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token]
 are set in the response.
        string redirect_uri = 12;
        Parameters:
        value - The redirectUri to set.
        Returns:
        This builder for chaining.

      • clearRedirectUri

        public SearchResponse.Builder clearRedirectUri()
         The URI of a customer-defined redirect page. If redirect action is
 triggered, no search is performed, and only
 [redirect_uri][google.cloud.discoveryengine.v1.SearchResponse.redirect_uri]
 and
 [attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token]
 are set in the response.
        string redirect_uri = 12;
        Returns:
        This builder for chaining.

      • setRedirectUriBytes

        public SearchResponse.Builder setRedirectUriBytes​(com.google.protobuf.ByteString value)
         The URI of a customer-defined redirect page. If redirect action is
 triggered, no search is performed, and only
 [redirect_uri][google.cloud.discoveryengine.v1.SearchResponse.redirect_uri]
 and
 [attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token]
 are set in the response.
        string redirect_uri = 12;
        Parameters:
        value - The bytes for redirectUri to set.
        Returns:
        This builder for chaining.

      • getNextPageToken

        public String getNextPageToken()
         A token that can be sent as
 [SearchRequest.page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token]
 to retrieve the next page. If this field is omitted, there are no
 subsequent pages.
        string next_page_token = 5;
        Specified by:
        getNextPageToken in interface SearchResponseOrBuilder
        Returns:
        The nextPageToken.

      • getNextPageTokenBytes

        public com.google.protobuf.ByteString getNextPageTokenBytes()
         A token that can be sent as
 [SearchRequest.page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token]
 to retrieve the next page. If this field is omitted, there are no
 subsequent pages.
        string next_page_token = 5;
        Specified by:
        getNextPageTokenBytes in interface SearchResponseOrBuilder
        Returns:
        The bytes for nextPageToken.

      • setNextPageToken

        public SearchResponse.Builder setNextPageToken​(String value)
         A token that can be sent as
 [SearchRequest.page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token]
 to retrieve the next page. If this field is omitted, there are no
 subsequent pages.
        string next_page_token = 5;
        Parameters:
        value - The nextPageToken to set.
        Returns:
        This builder for chaining.

      • clearNextPageToken

        public SearchResponse.Builder clearNextPageToken()
         A token that can be sent as
 [SearchRequest.page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token]
 to retrieve the next page. If this field is omitted, there are no
 subsequent pages.
        string next_page_token = 5;
        Returns:
        This builder for chaining.

      • setNextPageTokenBytes

        public SearchResponse.Builder setNextPageTokenBytes​(com.google.protobuf.ByteString value)
         A token that can be sent as
 [SearchRequest.page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token]
 to retrieve the next page. If this field is omitted, there are no
 subsequent pages.
        string next_page_token = 5;
        Parameters:
        value - The bytes for nextPageToken to set.
        Returns:
        This builder for chaining.

      • getCorrectedQuery

        public String getCorrectedQuery()
         Contains the spell corrected query, if found. If the spell correction type
 is AUTOMATIC, then the search results are based on corrected_query.
 Otherwise the original query is used for search.
        string corrected_query = 7;
        Specified by:
        getCorrectedQuery in interface SearchResponseOrBuilder
        Returns:
        The correctedQuery.

      • getCorrectedQueryBytes

        public com.google.protobuf.ByteString getCorrectedQueryBytes()
         Contains the spell corrected query, if found. If the spell correction type
 is AUTOMATIC, then the search results are based on corrected_query.
 Otherwise the original query is used for search.
        string corrected_query = 7;
        Specified by:
        getCorrectedQueryBytes in interface SearchResponseOrBuilder
        Returns:
        The bytes for correctedQuery.

      • setCorrectedQuery

        public SearchResponse.Builder setCorrectedQuery​(String value)
         Contains the spell corrected query, if found. If the spell correction type
 is AUTOMATIC, then the search results are based on corrected_query.
 Otherwise the original query is used for search.
        string corrected_query = 7;
        Parameters:
        value - The correctedQuery to set.
        Returns:
        This builder for chaining.

      • clearCorrectedQuery

        public SearchResponse.Builder clearCorrectedQuery()
         Contains the spell corrected query, if found. If the spell correction type
 is AUTOMATIC, then the search results are based on corrected_query.
 Otherwise the original query is used for search.
        string corrected_query = 7;
        Returns:
        This builder for chaining.

      • setCorrectedQueryBytes

        public SearchResponse.Builder setCorrectedQueryBytes​(com.google.protobuf.ByteString value)
         Contains the spell corrected query, if found. If the spell correction type
 is AUTOMATIC, then the search results are based on corrected_query.
 Otherwise the original query is used for search.
        string corrected_query = 7;
        Parameters:
        value - The bytes for correctedQuery to set.
        Returns:
        This builder for chaining.

      • hasSummary

        public boolean hasSummary()
         A summary as part of the search results.
 This field is only returned if
 [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.summary_spec]
 is set.
        .google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;
        Specified by:
        hasSummary in interface SearchResponseOrBuilder
        Returns:
        Whether the summary field is set.

      • getSummary

        public SearchResponse.Summary getSummary()
         A summary as part of the search results.
 This field is only returned if
 [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.summary_spec]
 is set.
        .google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;
        Specified by:
        getSummary in interface SearchResponseOrBuilder
        Returns:
        The summary.

      • setSummary

        public SearchResponse.Builder setSummary​(SearchResponse.Summary value)
         A summary as part of the search results.
 This field is only returned if
 [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.summary_spec]
 is set.
        .google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;

      • setSummary

        public SearchResponse.Builder setSummary​(SearchResponse.Summary.Builder builderForValue)
         A summary as part of the search results.
 This field is only returned if
 [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.summary_spec]
 is set.
        .google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;

      • mergeSummary

        public SearchResponse.Builder mergeSummary​(SearchResponse.Summary value)
         A summary as part of the search results.
 This field is only returned if
 [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.summary_spec]
 is set.
        .google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;

      • clearSummary

        public SearchResponse.Builder clearSummary()
         A summary as part of the search results.
 This field is only returned if
 [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.summary_spec]
 is set.
        .google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;

      • getSummaryBuilder

        public SearchResponse.Summary.Builder getSummaryBuilder()
         A summary as part of the search results.
 This field is only returned if
 [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.summary_spec]
 is set.
        .google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;

      • getSummaryOrBuilder

        public SearchResponse.SummaryOrBuilder getSummaryOrBuilder()
         A summary as part of the search results.
 This field is only returned if
 [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.summary_spec]
 is set.
        .google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;
        Specified by:
        getSummaryOrBuilder in interface SearchResponseOrBuilder

      • hasQueryExpansionInfo

        public boolean hasQueryExpansionInfo()
         Query expansion information for the returned results.
        .google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo query_expansion_info = 14;
        Specified by:
        hasQueryExpansionInfo in interface SearchResponseOrBuilder
        Returns:
        Whether the queryExpansionInfo field is set.

      • clearQueryExpansionInfo

        public SearchResponse.Builder clearQueryExpansionInfo()
         Query expansion information for the returned results.
        .google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

      • getQueryExpansionInfoBuilder

        public SearchResponse.QueryExpansionInfo.Builder getQueryExpansionInfoBuilder()
         Query expansion information for the returned results.
        .google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

      • setUnknownFields

        public final SearchResponse.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<SearchResponse.Builder>

      • mergeUnknownFields

        public final SearchResponse.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<SearchResponse.Builder>