All Implemented Interfaces:


public abstract class Candidate.Builder

Builder for Candidate.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`Candidate.Builder()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract Candidate.Builder`	`content(Content content)`	Setter for content.
`Candidate.Builder`	`content(Content.Builder contentBuilder)`	Setter for content builder.
`Candidate.Builder`	`clearContent()`	Clears the value of content field.
`abstract Candidate.Builder`	`citationMetadata(CitationMetadata citationMetadata)`	Setter for citationMetadata.
`Candidate.Builder`	`citationMetadata(CitationMetadata.Builder citationMetadataBuilder)`	Setter for citationMetadata builder.
`Candidate.Builder`	`clearCitationMetadata()`	Clears the value of citationMetadata field.
`abstract Candidate.Builder`	`finishMessage(String finishMessage)`	Setter for finishMessage.
`Candidate.Builder`	`clearFinishMessage()`	Clears the value of finishMessage field.
`abstract Candidate.Builder`	`tokenCount(Integer tokenCount)`	Setter for tokenCount.
`Candidate.Builder`	`clearTokenCount()`	Clears the value of tokenCount field.
`abstract Candidate.Builder`	`finishReason(FinishReason finishReason)`	Setter for finishReason.
`Candidate.Builder`	`clearFinishReason()`	Clears the value of finishReason field.
`Candidate.Builder`	`finishReason(FinishReason.Known knownType)`	Setter for finishReason given a known enum.
`Candidate.Builder`	`finishReason(String finishReason)`	Setter for finishReason given a string.
`abstract Candidate.Builder`	`groundingMetadata(GroundingMetadata groundingMetadata)`	Setter for groundingMetadata.
`Candidate.Builder`	`groundingMetadata(GroundingMetadata.Builder groundingMetadataBuilder)`	Setter for groundingMetadata builder.
`Candidate.Builder`	`clearGroundingMetadata()`	Clears the value of groundingMetadata field.
`abstract Candidate.Builder`	`avgLogprobs(Double avgLogprobs)`	Setter for avgLogprobs.
`Candidate.Builder`	`clearAvgLogprobs()`	Clears the value of avgLogprobs field.
`abstract Candidate.Builder`	`index(Integer index)`	Setter for index.
`Candidate.Builder`	`clearIndex()`	Clears the value of index field.
`abstract Candidate.Builder`	`logprobsResult(LogprobsResult logprobsResult)`	Setter for logprobsResult.
`Candidate.Builder`	`logprobsResult(LogprobsResult.Builder logprobsResultBuilder)`	Setter for logprobsResult builder.
`Candidate.Builder`	`clearLogprobsResult()`	Clears the value of logprobsResult field.
`abstract Candidate.Builder`	`safetyRatings(List<SafetyRating> safetyRatings)`	Setter for safetyRatings.
`Candidate.Builder`	`safetyRatings(Array<SafetyRating> safetyRatings)`	Setter for safetyRatings.
`Candidate.Builder`	`safetyRatings(Array<SafetyRating.Builder> safetyRatingsBuilders)`	Setter for safetyRatings builder.
`Candidate.Builder`	`clearSafetyRatings()`	Clears the value of safetyRatings field.
`abstract Candidate.Builder`	`urlContextMetadata(UrlContextMetadata urlContextMetadata)`	Setter for urlContextMetadata.
`Candidate.Builder`	`urlContextMetadata(UrlContextMetadata.Builder urlContextMetadataBuilder)`	Setter for urlContextMetadata builder.
`Candidate.Builder`	`clearUrlContextMetadata()`	Clears the value of urlContextMetadata field.
`abstract Candidate`	`build()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Candidate.Builder
```
Candidate.Builder()
```
- Method Detail
  - content
```
 abstract Candidate.Builder content(Content content)
```
    Setter for content.
    content: Contains the multi-part content of the response.
  - content
```
@CanIgnoreReturnValue() Candidate.Builder content(Content.Builder contentBuilder)
```
    Setter for content builder.
    content: Contains the multi-part content of the response.
  - clearContent
```
@CanIgnoreReturnValue() Candidate.Builder clearContent()
```
    Clears the value of content field.
  - citationMetadata
```
 abstract Candidate.Builder citationMetadata(CitationMetadata citationMetadata)
```
    Setter for citationMetadata.
    citationMetadata: Source attribution of the generated content.
  - citationMetadata
```
@CanIgnoreReturnValue() Candidate.Builder citationMetadata(CitationMetadata.Builder citationMetadataBuilder)
```
    Setter for citationMetadata builder.
    citationMetadata: Source attribution of the generated content.
  - clearCitationMetadata
```
@CanIgnoreReturnValue() Candidate.Builder clearCitationMetadata()
```
    Clears the value of citationMetadata field.
  - finishMessage
```
 abstract Candidate.Builder finishMessage(String finishMessage)
```
    Setter for finishMessage.
    finishMessage: Describes the reason the model stopped generating tokens.
  - clearFinishMessage
```
@CanIgnoreReturnValue() Candidate.Builder clearFinishMessage()
```
    Clears the value of finishMessage field.
  - tokenCount
```
 abstract Candidate.Builder tokenCount(Integer tokenCount)
```
    Setter for tokenCount.
    tokenCount: Number of tokens for this candidate.
  - clearTokenCount
```
@CanIgnoreReturnValue() Candidate.Builder clearTokenCount()
```
    Clears the value of tokenCount field.
  - finishReason
```
 abstract Candidate.Builder finishReason(FinishReason finishReason)
```
    Setter for finishReason.
    finishReason: The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
  - clearFinishReason
```
@CanIgnoreReturnValue() Candidate.Builder clearFinishReason()
```
    Clears the value of finishReason field.
  - finishReason
```
@CanIgnoreReturnValue() Candidate.Builder finishReason(FinishReason.Known knownType)
```
    Setter for finishReason given a known enum.
    finishReason: The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
  - finishReason
```
@CanIgnoreReturnValue() Candidate.Builder finishReason(String finishReason)
```
    Setter for finishReason given a string.
    finishReason: The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
  - groundingMetadata
```
 abstract Candidate.Builder groundingMetadata(GroundingMetadata groundingMetadata)
```
    Setter for groundingMetadata.
    groundingMetadata: Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.
  - groundingMetadata
```
@CanIgnoreReturnValue() Candidate.Builder groundingMetadata(GroundingMetadata.Builder groundingMetadataBuilder)
```
    Setter for groundingMetadata builder.
    groundingMetadata: Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.
  - clearGroundingMetadata
```
@CanIgnoreReturnValue() Candidate.Builder clearGroundingMetadata()
```
    Clears the value of groundingMetadata field.
  - avgLogprobs
```
 abstract Candidate.Builder avgLogprobs(Double avgLogprobs)
```
    Setter for avgLogprobs.
    avgLogprobs: Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.
  - clearAvgLogprobs
```
@CanIgnoreReturnValue() Candidate.Builder clearAvgLogprobs()
```
    Clears the value of avgLogprobs field.
  - index
```
 abstract Candidate.Builder index(Integer index)
```
    Setter for index.
    index: Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` >1.
  - clearIndex
```
@CanIgnoreReturnValue() Candidate.Builder clearIndex()
```
    Clears the value of index field.
  - logprobsResult
```
 abstract Candidate.Builder logprobsResult(LogprobsResult logprobsResult)
```
    Setter for logprobsResult.
    logprobsResult: Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations".
  - logprobsResult
```
@CanIgnoreReturnValue() Candidate.Builder logprobsResult(LogprobsResult.Builder logprobsResultBuilder)
```
    Setter for logprobsResult builder.
    logprobsResult: Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations".
  - clearLogprobsResult
```
@CanIgnoreReturnValue() Candidate.Builder clearLogprobsResult()
```
    Clears the value of logprobsResult field.
  - safetyRatings
```
 abstract Candidate.Builder safetyRatings(List<SafetyRating> safetyRatings)
```
    Setter for safetyRatings.
    safetyRatings: Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.
  - safetyRatings
```
@CanIgnoreReturnValue() Candidate.Builder safetyRatings(Array<SafetyRating> safetyRatings)
```
    Setter for safetyRatings.
    safetyRatings: Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.
  - safetyRatings
```
@CanIgnoreReturnValue() Candidate.Builder safetyRatings(Array<SafetyRating.Builder> safetyRatingsBuilders)
```
    Setter for safetyRatings builder.
    safetyRatings: Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.
  - clearSafetyRatings
```
@CanIgnoreReturnValue() Candidate.Builder clearSafetyRatings()
```
    Clears the value of safetyRatings field.
  - urlContextMetadata
```
 abstract Candidate.Builder urlContextMetadata(UrlContextMetadata urlContextMetadata)
```
    Setter for urlContextMetadata.
    urlContextMetadata: Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.
  - urlContextMetadata
```
@CanIgnoreReturnValue() Candidate.Builder urlContextMetadata(UrlContextMetadata.Builder urlContextMetadataBuilder)
```
    Setter for urlContextMetadata builder.
    urlContextMetadata: Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.
  - clearUrlContextMetadata
```
@CanIgnoreReturnValue() Candidate.Builder clearUrlContextMetadata()
```
    Clears the value of urlContextMetadata field.
  - build
```
 abstract Candidate build()
```

Class Candidate.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Candidate.Builder

Method Detail

content

content

clearContent

citationMetadata

citationMetadata

clearCitationMetadata

finishMessage

clearFinishMessage

tokenCount

clearTokenCount

finishReason

clearFinishReason

finishReason

finishReason

groundingMetadata

groundingMetadata

clearGroundingMetadata

avgLogprobs

clearAvgLogprobs

index

clearIndex

logprobsResult

logprobsResult

clearLogprobsResult

safetyRatings

safetyRatings

safetyRatings

clearSafetyRatings

urlContextMetadata

urlContextMetadata

clearUrlContextMetadata

build