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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1Answer
extends com.google.api.client.json.GenericJson
```
Defines an answer.
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

GoogleCloudDiscoveryengineV1Answer()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1Answer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1Answer`	`clone()`
`List<String>`	`getAnswerSkippedReasons()` Additional answer-skipped reasons.
`String`	`getAnswerText()` The textual answer.
`List<GoogleCloudDiscoveryengineV1AnswerCitation>`	`getCitations()` Citations.
`String`	`getCompleteTime()` Output only.
`String`	`getCreateTime()` Output only.
`Double`	`getGroundingScore()` A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
`List<GoogleCloudDiscoveryengineV1AnswerGroundingSupport>`	`getGroundingSupports()` Optional.
`String`	`getName()` Immutable.
`GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo`	`getQueryUnderstandingInfo()` Query understanding information.
`List<GoogleCloudDiscoveryengineV1AnswerReference>`	`getReferences()` References.
`List<String>`	`getRelatedQuestions()` Suggested related questions.
`List<GoogleCloudDiscoveryengineV1SafetyRating>`	`getSafetyRatings()` Optional.
`String`	`getState()` The state of the answer generation.
`List<GoogleCloudDiscoveryengineV1AnswerStep>`	`getSteps()` Answer generation steps.
`GoogleCloudDiscoveryengineV1Answer`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1Answer`	`setAnswerSkippedReasons(List<String> answerSkippedReasons)` Additional answer-skipped reasons.
`GoogleCloudDiscoveryengineV1Answer`	`setAnswerText(String answerText)` The textual answer.
`GoogleCloudDiscoveryengineV1Answer`	`setCitations(List<GoogleCloudDiscoveryengineV1AnswerCitation> citations)` Citations.
`GoogleCloudDiscoveryengineV1Answer`	`setCompleteTime(String completeTime)` Output only.
`GoogleCloudDiscoveryengineV1Answer`	`setCreateTime(String createTime)` Output only.
`GoogleCloudDiscoveryengineV1Answer`	`setGroundingScore(Double groundingScore)` A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
`GoogleCloudDiscoveryengineV1Answer`	`setGroundingSupports(List<GoogleCloudDiscoveryengineV1AnswerGroundingSupport> groundingSupports)` Optional.
`GoogleCloudDiscoveryengineV1Answer`	`setName(String name)` Immutable.
`GoogleCloudDiscoveryengineV1Answer`	`setQueryUnderstandingInfo(GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo queryUnderstandingInfo)` Query understanding information.
`GoogleCloudDiscoveryengineV1Answer`	`setReferences(List<GoogleCloudDiscoveryengineV1AnswerReference> references)` References.
`GoogleCloudDiscoveryengineV1Answer`	`setRelatedQuestions(List<String> relatedQuestions)` Suggested related questions.
`GoogleCloudDiscoveryengineV1Answer`	`setSafetyRatings(List<GoogleCloudDiscoveryengineV1SafetyRating> safetyRatings)` Optional.
`GoogleCloudDiscoveryengineV1Answer`	`setState(String state)` The state of the answer generation.
`GoogleCloudDiscoveryengineV1Answer`	`setSteps(List<GoogleCloudDiscoveryengineV1AnswerStep> steps)` Answer generation steps.

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
  - GoogleCloudDiscoveryengineV1Answer
```
public GoogleCloudDiscoveryengineV1Answer()
```
- Method Detail
  - getAnswerSkippedReasons
```
public List<String> getAnswerSkippedReasons()
```
    Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    
    Returns:
    
    value or null for none
  - setAnswerSkippedReasons
```
public GoogleCloudDiscoveryengineV1Answer setAnswerSkippedReasons(List<String> answerSkippedReasons)
```
    Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    
    Parameters:
    
    answerSkippedReasons - answerSkippedReasons or null for none
  - getAnswerText
```
public String getAnswerText()
```
    The textual answer.
    
    Returns:
    
    value or null for none
  - setAnswerText
```
public GoogleCloudDiscoveryengineV1Answer setAnswerText(String answerText)
```
    The textual answer.
    
    Parameters:
    
    answerText - answerText or null for none
  - getCitations
```
public List<GoogleCloudDiscoveryengineV1AnswerCitation> getCitations()
```
    Citations.
    
    Returns:
    
    value or null for none
  - setCitations
```
public GoogleCloudDiscoveryengineV1Answer setCitations(List<GoogleCloudDiscoveryengineV1AnswerCitation> citations)
```
    Citations.
    
    Parameters:
    
    citations - citations or null for none
  - getCompleteTime
```
public String getCompleteTime()
```
    Output only. Answer completed timestamp.
    
    Returns:
    
    value or null for none
  - setCompleteTime
```
public GoogleCloudDiscoveryengineV1Answer setCompleteTime(String completeTime)
```
    Output only. Answer completed timestamp.
    
    Parameters:
    
    completeTime - completeTime or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. Answer creation timestamp.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public GoogleCloudDiscoveryengineV1Answer setCreateTime(String createTime)
```
    Output only. Answer creation timestamp.
    
    Parameters:
    
    createTime - createTime or null for none
  - getGroundingScore
```
public Double getGroundingScore()
```
    A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
    
    Returns:
    
    value or null for none
  - setGroundingScore
```
public GoogleCloudDiscoveryengineV1Answer setGroundingScore(Double groundingScore)
```
    A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
    
    Parameters:
    
    groundingScore - groundingScore or null for none
  - getGroundingSupports
```
public List<GoogleCloudDiscoveryengineV1AnswerGroundingSupport> getGroundingSupports()
```
    Optional. Grounding supports.
    
    Returns:
    
    value or null for none
  - setGroundingSupports
```
public GoogleCloudDiscoveryengineV1Answer setGroundingSupports(List<GoogleCloudDiscoveryengineV1AnswerGroundingSupport> groundingSupports)
```
    Optional. Grounding supports.
    
    Parameters:
    
    groundingSupports - groundingSupports or null for none
  - getName
```
public String getName()
```
    Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/e ngines/{engine}/sessions/answers`
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudDiscoveryengineV1Answer setName(String name)
```
    Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/e ngines/{engine}/sessions/answers`
    
    Parameters:
    
    name - name or null for none
  - getQueryUnderstandingInfo
```
public GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo getQueryUnderstandingInfo()
```
    Query understanding information.
    
    Returns:
    
    value or null for none
  - setQueryUnderstandingInfo
```
public GoogleCloudDiscoveryengineV1Answer setQueryUnderstandingInfo(GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo queryUnderstandingInfo)
```
    Query understanding information.
    
    Parameters:
    
    queryUnderstandingInfo - queryUnderstandingInfo or null for none
  - getReferences
```
public List<GoogleCloudDiscoveryengineV1AnswerReference> getReferences()
```
    References.
    
    Returns:
    
    value or null for none
  - setReferences
```
public GoogleCloudDiscoveryengineV1Answer setReferences(List<GoogleCloudDiscoveryengineV1AnswerReference> references)
```
    References.
    
    Parameters:
    
    references - references or null for none
  - getRelatedQuestions
```
public List<String> getRelatedQuestions()
```
    Suggested related questions.
    
    Returns:
    
    value or null for none
  - setRelatedQuestions
```
public GoogleCloudDiscoveryengineV1Answer setRelatedQuestions(List<String> relatedQuestions)
```
    Suggested related questions.
    
    Parameters:
    
    relatedQuestions - relatedQuestions or null for none
  - getSafetyRatings
```
public List<GoogleCloudDiscoveryengineV1SafetyRating> getSafetyRatings()
```
    Optional. Safety ratings.
    
    Returns:
    
    value or null for none
  - setSafetyRatings
```
public GoogleCloudDiscoveryengineV1Answer setSafetyRatings(List<GoogleCloudDiscoveryengineV1SafetyRating> safetyRatings)
```
    Optional. Safety ratings.
    
    Parameters:
    
    safetyRatings - safetyRatings or null for none
  - getState
```
public String getState()
```
    The state of the answer generation.
    
    Returns:
    
    value or null for none
  - setState
```
public GoogleCloudDiscoveryengineV1Answer setState(String state)
```
    The state of the answer generation.
    
    Parameters:
    
    state - state or null for none
  - getSteps
```
public List<GoogleCloudDiscoveryengineV1AnswerStep> getSteps()
```
    Answer generation steps.
    
    Returns:
    
    value or null for none
  - setSteps
```
public GoogleCloudDiscoveryengineV1Answer setSteps(List<GoogleCloudDiscoveryengineV1AnswerStep> steps)
```
    Answer generation steps.
    
    Parameters:
    
    steps - steps or null for none
  - set
```
public GoogleCloudDiscoveryengineV1Answer set(String fieldName,
                                              Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1Answer clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1Answer

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

GoogleCloudDiscoveryengineV1Answer

Method Detail

getAnswerSkippedReasons

setAnswerSkippedReasons

getAnswerText

setAnswerText

getCitations

setCitations

getCompleteTime

setCompleteTime

getCreateTime

setCreateTime

getGroundingScore

setGroundingScore

getGroundingSupports

setGroundingSupports

getName

setName

getQueryUnderstandingInfo

setQueryUnderstandingInfo

getReferences

setReferences

getRelatedQuestions

setRelatedQuestions

getSafetyRatings

setSafetyRatings

getState

setState

getSteps

setSteps

set

clone