GoogleCloudDiscoveryengineV1SearchResponse (Discovery Engine API v1-rev20260427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1SearchResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1SearchResponse
extends com.google.api.client.json.GenericJson
```
Response message for SearchService.Search method.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudDiscoveryengineV1SearchResponse()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1SearchResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1SearchResponse`	`clone()`
`String`	`getAttributionToken()` A unique search token.
`String`	`getCorrectedQuery()` Contains the spell corrected query, if found.
`List<GoogleCloudDiscoveryengineV1SearchResponseFacet>`	`getFacets()` Results of facets requested by user.
`GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfo`	`getNaturalLanguageQueryUnderstandingInfo()` Output only.
`String`	`getNextPageToken()` A token that can be sent as SearchRequest.page_token to retrieve the next page.
`GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo`	`getQueryExpansionInfo()` Query expansion information for the returned results.
`String`	`getRedirectUri()` The URI of a customer-defined redirect page.
`List<GoogleCloudDiscoveryengineV1SearchResponseSearchResult>`	`getResults()` A list of matched documents.
`List<GoogleCloudDiscoveryengineV1SearchLinkPromotion>`	`getSearchLinkPromotions()` Promotions for site search.
`String`	`getSemanticState()` Output only.
`GoogleCloudDiscoveryengineV1SearchResponseSessionInfo`	`getSessionInfo()` Session information.
`GoogleCloudDiscoveryengineV1SearchResponseSummary`	`getSummary()` A summary as part of the search results.
`Integer`	`getTotalSize()` The estimated total count of matched items irrespective of pagination.
`GoogleCloudDiscoveryengineV1SearchResponse`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1SearchResponse`	`setAttributionToken(String attributionToken)` A unique search token.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setCorrectedQuery(String correctedQuery)` Contains the spell corrected query, if found.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setFacets(List<GoogleCloudDiscoveryengineV1SearchResponseFacet> facets)` Results of facets requested by user.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setNaturalLanguageQueryUnderstandingInfo(GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfo naturalLanguageQueryUnderstandingInfo)` Output only.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setNextPageToken(String nextPageToken)` A token that can be sent as SearchRequest.page_token to retrieve the next page.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setQueryExpansionInfo(GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo queryExpansionInfo)` Query expansion information for the returned results.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setRedirectUri(String redirectUri)` The URI of a customer-defined redirect page.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setResults(List<GoogleCloudDiscoveryengineV1SearchResponseSearchResult> results)` A list of matched documents.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setSearchLinkPromotions(List<GoogleCloudDiscoveryengineV1SearchLinkPromotion> searchLinkPromotions)` Promotions for site search.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setSemanticState(String semanticState)` Output only.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setSessionInfo(GoogleCloudDiscoveryengineV1SearchResponseSessionInfo sessionInfo)` Session information.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setSummary(GoogleCloudDiscoveryengineV1SearchResponseSummary summary)` A summary as part of the search results.
`GoogleCloudDiscoveryengineV1SearchResponse`	`setTotalSize(Integer totalSize)` The estimated total count of matched items irrespective of pagination.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudDiscoveryengineV1SearchResponse
```
public GoogleCloudDiscoveryengineV1SearchResponse()
```
- Method Detail
  - getAttributionToken
```
public String getAttributionToken()
```
    A unique search token. This should be included in the 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.
    
    Returns:
    
    value or null for none
  - setAttributionToken
```
public GoogleCloudDiscoveryengineV1SearchResponse setAttributionToken(String attributionToken)
```
    A unique search token. This should be included in the 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.
    
    Parameters:
    
    attributionToken - attributionToken or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setCorrectedQuery
```
public GoogleCloudDiscoveryengineV1SearchResponse setCorrectedQuery(String correctedQuery)
```
    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.
    
    Parameters:
    
    correctedQuery - correctedQuery or null for none
  - getFacets
```
public List<GoogleCloudDiscoveryengineV1SearchResponseFacet> getFacets()
```
    Results of facets requested by user.
    
    Returns:
    
    value or null for none
  - setFacets
```
public GoogleCloudDiscoveryengineV1SearchResponse setFacets(List<GoogleCloudDiscoveryengineV1SearchResponseFacet> facets)
```
    Results of facets requested by user.
    
    Parameters:
    
    facets - facets or null for none
  - getNaturalLanguageQueryUnderstandingInfo
```
public GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfo getNaturalLanguageQueryUnderstandingInfo()
```
    Output only. Natural language query understanding information for the returned results.
    
    Returns:
    
    value or null for none
  - setNaturalLanguageQueryUnderstandingInfo
```
public GoogleCloudDiscoveryengineV1SearchResponse setNaturalLanguageQueryUnderstandingInfo(GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfo naturalLanguageQueryUnderstandingInfo)
```
    Output only. Natural language query understanding information for the returned results.
    
    Parameters:
    
    naturalLanguageQueryUnderstandingInfo - naturalLanguageQueryUnderstandingInfo or null for none
  - getNextPageToken
```
public String getNextPageToken()
```
    A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
    
    Returns:
    
    value or null for none
  - setNextPageToken
```
public GoogleCloudDiscoveryengineV1SearchResponse setNextPageToken(String nextPageToken)
```
    A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
    
    Parameters:
    
    nextPageToken - nextPageToken or null for none
  - getQueryExpansionInfo
```
public GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo getQueryExpansionInfo()
```
    Query expansion information for the returned results.
    
    Returns:
    
    value or null for none
  - setQueryExpansionInfo
```
public GoogleCloudDiscoveryengineV1SearchResponse setQueryExpansionInfo(GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo queryExpansionInfo)
```
    Query expansion information for the returned results.
    
    Parameters:
    
    queryExpansionInfo - queryExpansionInfo or null for none
  - 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 and attribution_token are set in the response.
    
    Returns:
    
    value or null for none
  - setRedirectUri
```
public GoogleCloudDiscoveryengineV1SearchResponse setRedirectUri(String redirectUri)
```
    The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.
    
    Parameters:
    
    redirectUri - redirectUri or null for none
  - getResults
```
public List<GoogleCloudDiscoveryengineV1SearchResponseSearchResult> getResults()
```
    A list of matched documents. The order represents the ranking.
    
    Returns:
    
    value or null for none
  - setResults
```
public GoogleCloudDiscoveryengineV1SearchResponse setResults(List<GoogleCloudDiscoveryengineV1SearchResponseSearchResult> results)
```
    A list of matched documents. The order represents the ranking.
    
    Parameters:
    
    results - results or null for none
  - getSearchLinkPromotions
```
public List<GoogleCloudDiscoveryengineV1SearchLinkPromotion> getSearchLinkPromotions()
```
    Promotions for site search.
    
    Returns:
    
    value or null for none
  - setSearchLinkPromotions
```
public GoogleCloudDiscoveryengineV1SearchResponse setSearchLinkPromotions(List<GoogleCloudDiscoveryengineV1SearchLinkPromotion> searchLinkPromotions)
```
    Promotions for site search.
    
    Parameters:
    
    searchLinkPromotions - searchLinkPromotions or null for none
  - getSemanticState
```
public String getSemanticState()
```
    Output only. Indicates the semantic state of the search response.
    
    Returns:
    
    value or null for none
  - setSemanticState
```
public GoogleCloudDiscoveryengineV1SearchResponse setSemanticState(String semanticState)
```
    Output only. Indicates the semantic state of the search response.
    
    Parameters:
    
    semanticState - semanticState or null for none
  - getSessionInfo
```
public GoogleCloudDiscoveryengineV1SearchResponseSessionInfo getSessionInfo()
```
    Session information. Only set if SearchRequest.session is provided. See its description for more details.
    
    Returns:
    
    value or null for none
  - setSessionInfo
```
public GoogleCloudDiscoveryengineV1SearchResponse setSessionInfo(GoogleCloudDiscoveryengineV1SearchResponseSessionInfo sessionInfo)
```
    Session information. Only set if SearchRequest.session is provided. See its description for more details.
    
    Parameters:
    
    sessionInfo - sessionInfo or null for none
  - getSummary
```
public GoogleCloudDiscoveryengineV1SearchResponseSummary getSummary()
```
    A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
    
    Returns:
    
    value or null for none
  - setSummary
```
public GoogleCloudDiscoveryengineV1SearchResponse setSummary(GoogleCloudDiscoveryengineV1SearchResponseSummary summary)
```
    A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
    
    Parameters:
    
    summary - summary or null for none
  - getTotalSize
```
public Integer getTotalSize()
```
    The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.
    
    Returns:
    
    value or null for none
  - setTotalSize
```
public GoogleCloudDiscoveryengineV1SearchResponse setTotalSize(Integer totalSize)
```
    The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.
    
    Parameters:
    
    totalSize - totalSize or null for none
  - set
```
public GoogleCloudDiscoveryengineV1SearchResponse set(String fieldName,
                                                      Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1SearchResponse clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1SearchResponse

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudDiscoveryengineV1SearchResponse

Method Detail

getAttributionToken

setAttributionToken

getCorrectedQuery

setCorrectedQuery

getFacets

setFacets

getNaturalLanguageQueryUnderstandingInfo

setNaturalLanguageQueryUnderstandingInfo

getNextPageToken

setNextPageToken

getQueryExpansionInfo

setQueryExpansionInfo

getRedirectUri

setRedirectUri

getResults

setResults

getSearchLinkPromotions

setSearchLinkPromotions

getSemanticState

setSemanticState

getSessionInfo

setSessionInfo

getSummary

setSummary

getTotalSize

setTotalSize

set

clone