GoogleCloudDiscoveryengineV1AnswerQueryRequest (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.GoogleCloudDiscoveryengineV1AnswerQueryRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1AnswerQueryRequest
extends com.google.api.client.json.GenericJson
```
Request message for ConversationalSearchService.AnswerQuery 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

GoogleCloudDiscoveryengineV1AnswerQueryRequest()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1AnswerQueryRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`clone()`
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec`	`getAnswerGenerationSpec()` Answer generation specification.
`Boolean`	`getAsynchronousMode()` Deprecated: This field is deprecated.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec`	`getEndUserSpec()` Optional.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec`	`getGroundingSpec()` Optional.
`GoogleCloudDiscoveryengineV1Query`	`getQuery()` Required.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec`	`getQueryUnderstandingSpec()` Query understanding specification.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec`	`getRelatedQuestionsSpec()` Related questions specification.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec`	`getSafetySpec()` Model specification.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec`	`getSearchSpec()` Search specification.
`String`	`getSession()` The session resource name.
`Map<String,String>`	`getUserLabels()` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
`String`	`getUserPseudoId()` A unique identifier for tracking visitors.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setAnswerGenerationSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec answerGenerationSpec)` Answer generation specification.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setAsynchronousMode(Boolean asynchronousMode)` Deprecated: This field is deprecated.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setEndUserSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec endUserSpec)` Optional.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setGroundingSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec groundingSpec)` Optional.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setQuery(GoogleCloudDiscoveryengineV1Query query)` Required.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setQueryUnderstandingSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec queryUnderstandingSpec)` Query understanding specification.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setRelatedQuestionsSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec relatedQuestionsSpec)` Related questions specification.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setSafetySpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec safetySpec)` Model specification.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setSearchSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec searchSpec)` Search specification.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setSession(String session)` The session resource name.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setUserLabels(Map<String,String> userLabels)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
`GoogleCloudDiscoveryengineV1AnswerQueryRequest`	`setUserPseudoId(String userPseudoId)` A unique identifier for tracking visitors.

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
  - GoogleCloudDiscoveryengineV1AnswerQueryRequest
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest()
```
- Method Detail
  - getAnswerGenerationSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec getAnswerGenerationSpec()
```
    Answer generation specification.
    
    Returns:
    
    value or null for none
  - setAnswerGenerationSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setAnswerGenerationSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec answerGenerationSpec)
```
    Answer generation specification.
    
    Parameters:
    
    answerGenerationSpec - answerGenerationSpec or null for none
  - getAsynchronousMode
```
public Boolean getAsynchronousMode()
```
    Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
    
    Returns:
    
    value or null for none
  - setAsynchronousMode
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setAsynchronousMode(Boolean asynchronousMode)
```
    Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
    
    Parameters:
    
    asynchronousMode - asynchronousMode or null for none
  - getEndUserSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec getEndUserSpec()
```
    Optional. End user specification.
    
    Returns:
    
    value or null for none
  - setEndUserSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setEndUserSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec endUserSpec)
```
    Optional. End user specification.
    
    Parameters:
    
    endUserSpec - endUserSpec or null for none
  - getGroundingSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec getGroundingSpec()
```
    Optional. Grounding specification.
    
    Returns:
    
    value or null for none
  - setGroundingSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setGroundingSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec groundingSpec)
```
    Optional. Grounding specification.
    
    Parameters:
    
    groundingSpec - groundingSpec or null for none
  - getQuery
```
public GoogleCloudDiscoveryengineV1Query getQuery()
```
    Required. Current user query.
    
    Returns:
    
    value or null for none
  - setQuery
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setQuery(GoogleCloudDiscoveryengineV1Query query)
```
    Required. Current user query.
    
    Parameters:
    
    query - query or null for none
  - getQueryUnderstandingSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec getQueryUnderstandingSpec()
```
    Query understanding specification.
    
    Returns:
    
    value or null for none
  - setQueryUnderstandingSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setQueryUnderstandingSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec queryUnderstandingSpec)
```
    Query understanding specification.
    
    Parameters:
    
    queryUnderstandingSpec - queryUnderstandingSpec or null for none
  - getRelatedQuestionsSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec getRelatedQuestionsSpec()
```
    Related questions specification.
    
    Returns:
    
    value or null for none
  - setRelatedQuestionsSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setRelatedQuestionsSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec relatedQuestionsSpec)
```
    Related questions specification.
    
    Parameters:
    
    relatedQuestionsSpec - relatedQuestionsSpec or null for none
  - getSafetySpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec getSafetySpec()
```
    Model specification.
    
    Returns:
    
    value or null for none
  - setSafetySpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setSafetySpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec safetySpec)
```
    Model specification.
    
    Parameters:
    
    safetySpec - safetySpec or null for none
  - getSearchSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec getSearchSpec()
```
    Search specification.
    
    Returns:
    
    value or null for none
  - setSearchSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setSearchSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec searchSpec)
```
    Search specification.
    
    Parameters:
    
    searchSpec - searchSpec or null for none
  - getSession
```
public String getSession()
```
    The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.
    
    Returns:
    
    value or null for none
  - setSession
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setSession(String session)
```
    The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.
    
    Parameters:
    
    session - session or null for none
  - getUserLabels
```
public Map<String,String> getUserLabels()
```
    The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
    
    Returns:
    
    value or null for none
  - setUserLabels
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setUserLabels(Map<String,String> userLabels)
```
    The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
    
    Parameters:
    
    userLabels - userLabels or null for none
  - getUserPseudoId
```
public String getUserPseudoId()
```
    A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
    
    Returns:
    
    value or null for none
  - setUserPseudoId
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest setUserPseudoId(String userPseudoId)
```
    A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
    
    Parameters:
    
    userPseudoId - userPseudoId or null for none
  - set
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest set(String fieldName,
                                                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1AnswerQueryRequest

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

GoogleCloudDiscoveryengineV1AnswerQueryRequest

Method Detail

getAnswerGenerationSpec

setAnswerGenerationSpec

getAsynchronousMode

setAsynchronousMode

getEndUserSpec

setEndUserSpec

getGroundingSpec

setGroundingSpec

getQuery

setQuery

getQueryUnderstandingSpec

setQueryUnderstandingSpec

getRelatedQuestionsSpec

setRelatedQuestionsSpec

getSafetySpec

setSafetySpec

getSearchSpec

setSearchSpec

getSession

setSession

getUserLabels

setUserLabels

getUserPseudoId

setUserPseudoId

set

clone