Package com.google.cloud.discoveryengine.v1

Class SearchResponse.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchResponse.Builder>
com.google.cloud.discoveryengine.v1.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.GeneratedMessage.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 Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

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

    • mergeFrom

      public SearchResponse.Builder mergeFrom(SearchResponse other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.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

    • getResultsList

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

    • 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

    • getResults

      public SearchResponse.SearchResult getResults(int index)
       A list of matched documents. The order represents the ranking.
      repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
      Specified by:
      getResults 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;

    • setResults

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

    • addResults

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

    • addResults

      public SearchResponse.Builder addResults(SearchResponse.SearchResult.Builder builderForValue)
       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.Builder builderForValue)
       A list of matched documents. The order represents the ranking.
      repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

    • addAllResults

      public SearchResponse.Builder addAllResults(Iterable<? extends SearchResponse.SearchResult> values)
       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;

    • getResultsOrBuilder

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

    • getResultsOrBuilderList

      public List<? extends SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()
       A list of matched documents. The order represents the ranking.
      repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
      Specified by:
      getResultsOrBuilderList in interface SearchResponseOrBuilder

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

    • getFacetsList

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

    • 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

    • getFacets

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

    • setFacets

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

    • setFacets

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

    • addFacets

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

    • addFacets

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

    • addFacets

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

    • addFacets

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

    • addAllFacets

      public SearchResponse.Builder addAllFacets(Iterable<? extends SearchResponse.Facet> values)
       Results of facets requested by user.
      repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

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

    • getFacetsOrBuilder

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

    • getFacetsOrBuilderList

      public List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()
       Results of facets requested by user.
      repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;
      Specified by:
      getFacetsOrBuilderList in interface SearchResponseOrBuilder

    • 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. This also helps to identify a request during the customer
 support scenarios.
      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. This also helps to identify a request during the customer
 support scenarios.
      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. This also helps to identify a request during the customer
 support scenarios.
      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. This also helps to identify a request during the customer
 support scenarios.
      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. This also helps to identify a request during the customer
 support scenarios.
      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.

    • getQueryExpansionInfo

      public SearchResponse.QueryExpansionInfo getQueryExpansionInfo()
       Query expansion information for the returned results.
      .google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo query_expansion_info = 14;
      Specified by:
      getQueryExpansionInfo in interface SearchResponseOrBuilder
      Returns:
      The queryExpansionInfo.

    • setQueryExpansionInfo

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

    • setQueryExpansionInfo

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

    • mergeQueryExpansionInfo

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

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

    • getQueryExpansionInfoOrBuilder

      public SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()
       Query expansion information for the returned results.
      .google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo query_expansion_info = 14;
      Specified by:
      getQueryExpansionInfoOrBuilder in interface SearchResponseOrBuilder

    • hasNaturalLanguageQueryUnderstandingInfo

      public boolean hasNaturalLanguageQueryUnderstandingInfo()
       Output only. Natural language query understanding information for the
 returned results.
      .google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasNaturalLanguageQueryUnderstandingInfo in interface SearchResponseOrBuilder
      Returns:
      Whether the naturalLanguageQueryUnderstandingInfo field is set.

    • getNaturalLanguageQueryUnderstandingInfo

      public SearchResponse.NaturalLanguageQueryUnderstandingInfo getNaturalLanguageQueryUnderstandingInfo()
       Output only. Natural language query understanding information for the
 returned results.
      .google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNaturalLanguageQueryUnderstandingInfo in interface SearchResponseOrBuilder
      Returns:
      The naturalLanguageQueryUnderstandingInfo.

    • setNaturalLanguageQueryUnderstandingInfo

      public SearchResponse.Builder setNaturalLanguageQueryUnderstandingInfo(SearchResponse.NaturalLanguageQueryUnderstandingInfo value)
       Output only. Natural language query understanding information for the
 returned results.
      .google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setNaturalLanguageQueryUnderstandingInfo

      public SearchResponse.Builder setNaturalLanguageQueryUnderstandingInfo(SearchResponse.NaturalLanguageQueryUnderstandingInfo.Builder builderForValue)
       Output only. Natural language query understanding information for the
 returned results.
      .google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeNaturalLanguageQueryUnderstandingInfo

      public SearchResponse.Builder mergeNaturalLanguageQueryUnderstandingInfo(SearchResponse.NaturalLanguageQueryUnderstandingInfo value)
       Output only. Natural language query understanding information for the
 returned results.
      .google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearNaturalLanguageQueryUnderstandingInfo

      public SearchResponse.Builder clearNaturalLanguageQueryUnderstandingInfo()
       Output only. Natural language query understanding information for the
 returned results.
      .google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getNaturalLanguageQueryUnderstandingInfoBuilder

      public SearchResponse.NaturalLanguageQueryUnderstandingInfo.Builder getNaturalLanguageQueryUnderstandingInfoBuilder()
       Output only. Natural language query understanding information for the
 returned results.
      .google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getNaturalLanguageQueryUnderstandingInfoOrBuilder

      public SearchResponse.NaturalLanguageQueryUnderstandingInfoOrBuilder getNaturalLanguageQueryUnderstandingInfoOrBuilder()
       Output only. Natural language query understanding information for the
 returned results.
      .google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNaturalLanguageQueryUnderstandingInfoOrBuilder in interface SearchResponseOrBuilder

    • hasSessionInfo

      public boolean hasSessionInfo()
       Session information.

 Only set if
 [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
 is provided. See its description for more details.
      .google.cloud.discoveryengine.v1.SearchResponse.SessionInfo session_info = 19;
      Specified by:
      hasSessionInfo in interface SearchResponseOrBuilder
      Returns:
      Whether the sessionInfo field is set.

    • getSessionInfo

      public SearchResponse.SessionInfo getSessionInfo()
       Session information.

 Only set if
 [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
 is provided. See its description for more details.
      .google.cloud.discoveryengine.v1.SearchResponse.SessionInfo session_info = 19;
      Specified by:
      getSessionInfo in interface SearchResponseOrBuilder
      Returns:
      The sessionInfo.

    • setSessionInfo

      public SearchResponse.Builder setSessionInfo(SearchResponse.SessionInfo value)
       Session information.

 Only set if
 [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
 is provided. See its description for more details.
      .google.cloud.discoveryengine.v1.SearchResponse.SessionInfo session_info = 19;

    • setSessionInfo

      public SearchResponse.Builder setSessionInfo(SearchResponse.SessionInfo.Builder builderForValue)
       Session information.

 Only set if
 [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
 is provided. See its description for more details.
      .google.cloud.discoveryengine.v1.SearchResponse.SessionInfo session_info = 19;

    • mergeSessionInfo

      public SearchResponse.Builder mergeSessionInfo(SearchResponse.SessionInfo value)
       Session information.

 Only set if
 [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
 is provided. See its description for more details.
      .google.cloud.discoveryengine.v1.SearchResponse.SessionInfo session_info = 19;

    • clearSessionInfo

      public SearchResponse.Builder clearSessionInfo()
       Session information.

 Only set if
 [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
 is provided. See its description for more details.
      .google.cloud.discoveryengine.v1.SearchResponse.SessionInfo session_info = 19;

    • getSessionInfoBuilder

      public SearchResponse.SessionInfo.Builder getSessionInfoBuilder()
       Session information.

 Only set if
 [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
 is provided. See its description for more details.
      .google.cloud.discoveryengine.v1.SearchResponse.SessionInfo session_info = 19;

    • getSessionInfoOrBuilder

      public SearchResponse.SessionInfoOrBuilder getSessionInfoOrBuilder()
       Session information.

 Only set if
 [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
 is provided. See its description for more details.
      .google.cloud.discoveryengine.v1.SearchResponse.SessionInfo session_info = 19;
      Specified by:
      getSessionInfoOrBuilder in interface SearchResponseOrBuilder

    • getSearchLinkPromotionsList

      public List<SearchLinkPromotion> getSearchLinkPromotionsList()
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;
      Specified by:
      getSearchLinkPromotionsList in interface SearchResponseOrBuilder

    • getSearchLinkPromotionsCount

      public int getSearchLinkPromotionsCount()
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;
      Specified by:
      getSearchLinkPromotionsCount in interface SearchResponseOrBuilder

    • getSearchLinkPromotions

      public SearchLinkPromotion getSearchLinkPromotions(int index)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;
      Specified by:
      getSearchLinkPromotions in interface SearchResponseOrBuilder

    • setSearchLinkPromotions

      public SearchResponse.Builder setSearchLinkPromotions(int index, SearchLinkPromotion value)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • setSearchLinkPromotions

      public SearchResponse.Builder setSearchLinkPromotions(int index, SearchLinkPromotion.Builder builderForValue)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • addSearchLinkPromotions

      public SearchResponse.Builder addSearchLinkPromotions(SearchLinkPromotion value)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • addSearchLinkPromotions

      public SearchResponse.Builder addSearchLinkPromotions(int index, SearchLinkPromotion value)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • addSearchLinkPromotions

      public SearchResponse.Builder addSearchLinkPromotions(SearchLinkPromotion.Builder builderForValue)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • addSearchLinkPromotions

      public SearchResponse.Builder addSearchLinkPromotions(int index, SearchLinkPromotion.Builder builderForValue)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • addAllSearchLinkPromotions

      public SearchResponse.Builder addAllSearchLinkPromotions(Iterable<? extends SearchLinkPromotion> values)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • clearSearchLinkPromotions

      public SearchResponse.Builder clearSearchLinkPromotions()
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • removeSearchLinkPromotions

      public SearchResponse.Builder removeSearchLinkPromotions(int index)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • getSearchLinkPromotionsBuilder

      public SearchLinkPromotion.Builder getSearchLinkPromotionsBuilder(int index)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • getSearchLinkPromotionsOrBuilder

      public SearchLinkPromotionOrBuilder getSearchLinkPromotionsOrBuilder(int index)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;
      Specified by:
      getSearchLinkPromotionsOrBuilder in interface SearchResponseOrBuilder

    • getSearchLinkPromotionsOrBuilderList

      public List<? extends SearchLinkPromotionOrBuilder> getSearchLinkPromotionsOrBuilderList()
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;
      Specified by:
      getSearchLinkPromotionsOrBuilderList in interface SearchResponseOrBuilder

    • addSearchLinkPromotionsBuilder

      public SearchLinkPromotion.Builder addSearchLinkPromotionsBuilder()
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • addSearchLinkPromotionsBuilder

      public SearchLinkPromotion.Builder addSearchLinkPromotionsBuilder(int index)
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • getSearchLinkPromotionsBuilderList

      public List<SearchLinkPromotion.Builder> getSearchLinkPromotionsBuilderList()
       Promotions for site search.
      repeated .google.cloud.discoveryengine.v1.SearchLinkPromotion search_link_promotions = 23;

    • getSemanticStateValue

      public int getSemanticStateValue()
       Output only. Indicates the semantic state of the search response.
      .google.cloud.discoveryengine.v1.SearchResponse.SemanticState semantic_state = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSemanticStateValue in interface SearchResponseOrBuilder
      Returns:
      The enum numeric value on the wire for semanticState.

    • setSemanticStateValue

      public SearchResponse.Builder setSemanticStateValue(int value)
       Output only. Indicates the semantic state of the search response.
      .google.cloud.discoveryengine.v1.SearchResponse.SemanticState semantic_state = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The enum numeric value on the wire for semanticState to set.
      Returns:
      This builder for chaining.

    • getSemanticState

      public SearchResponse.SemanticState getSemanticState()
       Output only. Indicates the semantic state of the search response.
      .google.cloud.discoveryengine.v1.SearchResponse.SemanticState semantic_state = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSemanticState in interface SearchResponseOrBuilder
      Returns:
      The semanticState.

    • setSemanticState

      public SearchResponse.Builder setSemanticState(SearchResponse.SemanticState value)
       Output only. Indicates the semantic state of the search response.
      .google.cloud.discoveryengine.v1.SearchResponse.SemanticState semantic_state = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The semanticState to set.
      Returns:
      This builder for chaining.

    • clearSemanticState

      public SearchResponse.Builder clearSemanticState()
       Output only. Indicates the semantic state of the search response.
      .google.cloud.discoveryengine.v1.SearchResponse.SemanticState semantic_state = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.