Candidate.Builder (proto-google-cloud-vertexai-v1 1.12.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>
    - - com.google.cloud.vertexai.api.Candidate.Builder

All Implemented Interfaces:

CandidateOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Candidate
```
public static final class Candidate.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>
implements CandidateOrBuilder
```
```
 A response candidate generated from the model.
 
```
Protobuf type google.cloud.vertexai.v1.Candidate

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Candidate.Builder`	`addAllSafetyRatings(Iterable<? extends SafetyRating> values)` Output only.
`Candidate.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Candidate.Builder`	`addSafetyRatings(int index, SafetyRating.Builder builderForValue)` Output only.
`Candidate.Builder`	`addSafetyRatings(int index, SafetyRating value)` Output only.
`Candidate.Builder`	`addSafetyRatings(SafetyRating.Builder builderForValue)` Output only.
`Candidate.Builder`	`addSafetyRatings(SafetyRating value)` Output only.
`SafetyRating.Builder`	`addSafetyRatingsBuilder()` Output only.
`SafetyRating.Builder`	`addSafetyRatingsBuilder(int index)` Output only.
`Candidate`	`build()`
`Candidate`	`buildPartial()`
`Candidate.Builder`	`clear()`
`Candidate.Builder`	`clearAvgLogprobs()` Output only.
`Candidate.Builder`	`clearCitationMetadata()` Output only.
`Candidate.Builder`	`clearContent()` Output only.
`Candidate.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Candidate.Builder`	`clearFinishMessage()` Output only.
`Candidate.Builder`	`clearFinishReason()` Output only.
`Candidate.Builder`	`clearGroundingMetadata()` Output only.
`Candidate.Builder`	`clearIndex()` Output only.
`Candidate.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Candidate.Builder`	`clearSafetyRatings()` Output only.
`Candidate.Builder`	`clearScore()` Output only.
`Candidate.Builder`	`clone()`
`double`	`getAvgLogprobs()` Output only.
`CitationMetadata`	`getCitationMetadata()` Output only.
`CitationMetadata.Builder`	`getCitationMetadataBuilder()` Output only.
`CitationMetadataOrBuilder`	`getCitationMetadataOrBuilder()` Output only.
`Content`	`getContent()` Output only.
`Content.Builder`	`getContentBuilder()` Output only.
`ContentOrBuilder`	`getContentOrBuilder()` Output only.
`Candidate`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getFinishMessage()` Output only.
`com.google.protobuf.ByteString`	`getFinishMessageBytes()` Output only.
`Candidate.FinishReason`	`getFinishReason()` Output only.
`int`	`getFinishReasonValue()` Output only.
`GroundingMetadata`	`getGroundingMetadata()` Output only.
`GroundingMetadata.Builder`	`getGroundingMetadataBuilder()` Output only.
`GroundingMetadataOrBuilder`	`getGroundingMetadataOrBuilder()` Output only.
`int`	`getIndex()` Output only.
`SafetyRating`	`getSafetyRatings(int index)` Output only.
`SafetyRating.Builder`	`getSafetyRatingsBuilder(int index)` Output only.
`List<SafetyRating.Builder>`	`getSafetyRatingsBuilderList()` Output only.
`int`	`getSafetyRatingsCount()` Output only.
`List<SafetyRating>`	`getSafetyRatingsList()` Output only.
`SafetyRatingOrBuilder`	`getSafetyRatingsOrBuilder(int index)` Output only.
`List<? extends SafetyRatingOrBuilder>`	`getSafetyRatingsOrBuilderList()` Output only.
`double`	`getScore()` Output only.
`boolean`	`hasCitationMetadata()` Output only.
`boolean`	`hasContent()` Output only.
`boolean`	`hasFinishMessage()` Output only.
`boolean`	`hasGroundingMetadata()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Candidate.Builder`	`mergeCitationMetadata(CitationMetadata value)` Output only.
`Candidate.Builder`	`mergeContent(Content value)` Output only.
`Candidate.Builder`	`mergeFrom(Candidate other)`
`Candidate.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Candidate.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Candidate.Builder`	`mergeGroundingMetadata(GroundingMetadata value)` Output only.
`Candidate.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Candidate.Builder`	`removeSafetyRatings(int index)` Output only.
`Candidate.Builder`	`setAvgLogprobs(double value)` Output only.
`Candidate.Builder`	`setCitationMetadata(CitationMetadata.Builder builderForValue)` Output only.
`Candidate.Builder`	`setCitationMetadata(CitationMetadata value)` Output only.
`Candidate.Builder`	`setContent(Content.Builder builderForValue)` Output only.
`Candidate.Builder`	`setContent(Content value)` Output only.
`Candidate.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Candidate.Builder`	`setFinishMessage(String value)` Output only.
`Candidate.Builder`	`setFinishMessageBytes(com.google.protobuf.ByteString value)` Output only.
`Candidate.Builder`	`setFinishReason(Candidate.FinishReason value)` Output only.
`Candidate.Builder`	`setFinishReasonValue(int value)` Output only.
`Candidate.Builder`	`setGroundingMetadata(GroundingMetadata.Builder builderForValue)` Output only.
`Candidate.Builder`	`setGroundingMetadata(GroundingMetadata value)` Output only.
`Candidate.Builder`	`setIndex(int value)` Output only.
`Candidate.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Candidate.Builder`	`setSafetyRatings(int index, SafetyRating.Builder builderForValue)` Output only.
`Candidate.Builder`	`setSafetyRatings(int index, SafetyRating value)` Output only.
`Candidate.Builder`	`setScore(double value)` Output only.
`Candidate.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>
  - clear
```
public Candidate.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.GeneratedMessageV3.Builder<Candidate.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.GeneratedMessageV3.Builder<Candidate.Builder>
  - getDefaultInstanceForType
```
public Candidate getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Candidate build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Candidate buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Candidate.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>
  - setField
```
public Candidate.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                  Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>
  - clearField
```
public Candidate.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>
  - clearOneof
```
public Candidate.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>
  - setRepeatedField
```
public Candidate.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          int index,
                                          Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>
  - addRepeatedField
```
public Candidate.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>
  - mergeFrom
```
public Candidate.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<Candidate.Builder>
  - mergeFrom
```
public Candidate.Builder mergeFrom(Candidate other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>
  - mergeFrom
```
public Candidate.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<Candidate.Builder>
    
    Throws:
    
    IOException
  - getIndex
```
public int getIndex()
```
```
 Output only. Index of the candidate.
 
```
    int32 index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getIndex in interface CandidateOrBuilder
    
    Returns:
    
    The index.
  - setIndex
```
public Candidate.Builder setIndex(int value)
```
```
 Output only. Index of the candidate.
 
```
    int32 index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Parameters:
    
    value - The index to set.
    
    Returns:
    
    This builder for chaining.
  - clearIndex
```
public Candidate.Builder clearIndex()
```
```
 Output only. Index of the candidate.
 
```
    int32 index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    This builder for chaining.
  - hasContent
```
public boolean hasContent()
```
```
 Output only. Content parts of the candidate.
 
```
    .google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    hasContent in interface CandidateOrBuilder
    
    Returns:
    
    Whether the content field is set.
  - getContent
```
public Content getContent()
```
```
 Output only. Content parts of the candidate.
 
```
    .google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getContent in interface CandidateOrBuilder
    
    Returns:
    
    The content.
  - setContent
```
public Candidate.Builder setContent(Content value)
```
```
 Output only. Content parts of the candidate.
 
```
    .google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - setContent
```
public Candidate.Builder setContent(Content.Builder builderForValue)
```
```
 Output only. Content parts of the candidate.
 
```
    .google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - mergeContent
```
public Candidate.Builder mergeContent(Content value)
```
```
 Output only. Content parts of the candidate.
 
```
    .google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - clearContent
```
public Candidate.Builder clearContent()
```
```
 Output only. Content parts of the candidate.
 
```
    .google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getContentBuilder
```
public Content.Builder getContentBuilder()
```
```
 Output only. Content parts of the candidate.
 
```
    .google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getContentOrBuilder
```
public ContentOrBuilder getContentOrBuilder()
```
```
 Output only. Content parts of the candidate.
 
```
    .google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getContentOrBuilder in interface CandidateOrBuilder
  - getScore
```
public double getScore()
```
```
 Output only. Confidence score of the candidate.
 
```
    double score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getScore in interface CandidateOrBuilder
    
    Returns:
    
    The score.
  - setScore
```
public Candidate.Builder setScore(double value)
```
```
 Output only. Confidence score of the candidate.
 
```
    double score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Parameters:
    
    value - The score to set.
    
    Returns:
    
    This builder for chaining.
  - clearScore
```
public Candidate.Builder clearScore()
```
```
 Output only. Confidence score of the candidate.
 
```
    double score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    This builder for chaining.
  - getAvgLogprobs
```
public double getAvgLogprobs()
```
```
 Output only. Average log probability score of the candidate.
 
```
    double avg_logprobs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getAvgLogprobs in interface CandidateOrBuilder
    
    Returns:
    
    The avgLogprobs.
  - setAvgLogprobs
```
public Candidate.Builder setAvgLogprobs(double value)
```
```
 Output only. Average log probability score of the candidate.
 
```
    double avg_logprobs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Parameters:
    
    value - The avgLogprobs to set.
    
    Returns:
    
    This builder for chaining.
  - clearAvgLogprobs
```
public Candidate.Builder clearAvgLogprobs()
```
```
 Output only. Average log probability score of the candidate.
 
```
    double avg_logprobs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    This builder for chaining.
  - getFinishReasonValue
```
public int getFinishReasonValue()
```
```
 Output only. The reason why the model stopped generating tokens.
 If empty, the model has not stopped generating the tokens.
 
```
    .google.cloud.vertexai.v1.Candidate.FinishReason finish_reason = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getFinishReasonValue in interface CandidateOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for finishReason.
  - setFinishReasonValue
```
public Candidate.Builder setFinishReasonValue(int value)
```
```
 Output only. The reason why the model stopped generating tokens.
 If empty, the model has not stopped generating the tokens.
 
```
    .google.cloud.vertexai.v1.Candidate.FinishReason finish_reason = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Parameters:
    
    value - The enum numeric value on the wire for finishReason to set.
    
    Returns:
    
    This builder for chaining.
  - getFinishReason
```
public Candidate.FinishReason getFinishReason()
```
```
 Output only. The reason why the model stopped generating tokens.
 If empty, the model has not stopped generating the tokens.
 
```
    .google.cloud.vertexai.v1.Candidate.FinishReason finish_reason = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getFinishReason in interface CandidateOrBuilder
    
    Returns:
    
    The finishReason.
  - setFinishReason
```
public Candidate.Builder setFinishReason(Candidate.FinishReason value)
```
```
 Output only. The reason why the model stopped generating tokens.
 If empty, the model has not stopped generating the tokens.
 
```
    .google.cloud.vertexai.v1.Candidate.FinishReason finish_reason = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Parameters:
    
    value - The finishReason to set.
    
    Returns:
    
    This builder for chaining.
  - clearFinishReason
```
public Candidate.Builder clearFinishReason()
```
```
 Output only. The reason why the model stopped generating tokens.
 If empty, the model has not stopped generating the tokens.
 
```
    .google.cloud.vertexai.v1.Candidate.FinishReason finish_reason = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    This builder for chaining.
  - getSafetyRatingsList
```
public List<SafetyRating> getSafetyRatingsList()
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getSafetyRatingsList in interface CandidateOrBuilder
  - getSafetyRatingsCount
```
public int getSafetyRatingsCount()
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getSafetyRatingsCount in interface CandidateOrBuilder
  - getSafetyRatings
```
public SafetyRating getSafetyRatings(int index)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getSafetyRatings in interface CandidateOrBuilder
  - setSafetyRatings
```
public Candidate.Builder setSafetyRatings(int index,
                                          SafetyRating value)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - setSafetyRatings
```
public Candidate.Builder setSafetyRatings(int index,
                                          SafetyRating.Builder builderForValue)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - addSafetyRatings
```
public Candidate.Builder addSafetyRatings(SafetyRating value)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - addSafetyRatings
```
public Candidate.Builder addSafetyRatings(int index,
                                          SafetyRating value)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - addSafetyRatings
```
public Candidate.Builder addSafetyRatings(SafetyRating.Builder builderForValue)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - addSafetyRatings
```
public Candidate.Builder addSafetyRatings(int index,
                                          SafetyRating.Builder builderForValue)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - addAllSafetyRatings
```
public Candidate.Builder addAllSafetyRatings(Iterable<? extends SafetyRating> values)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - clearSafetyRatings
```
public Candidate.Builder clearSafetyRatings()
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - removeSafetyRatings
```
public Candidate.Builder removeSafetyRatings(int index)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getSafetyRatingsBuilder
```
public SafetyRating.Builder getSafetyRatingsBuilder(int index)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getSafetyRatingsOrBuilder
```
public SafetyRatingOrBuilder getSafetyRatingsOrBuilder(int index)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getSafetyRatingsOrBuilder in interface CandidateOrBuilder
  - getSafetyRatingsOrBuilderList
```
public List<? extends SafetyRatingOrBuilder> getSafetyRatingsOrBuilderList()
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getSafetyRatingsOrBuilderList in interface CandidateOrBuilder
  - addSafetyRatingsBuilder
```
public SafetyRating.Builder addSafetyRatingsBuilder()
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - addSafetyRatingsBuilder
```
public SafetyRating.Builder addSafetyRatingsBuilder(int index)
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getSafetyRatingsBuilderList
```
public List<SafetyRating.Builder> getSafetyRatingsBuilderList()
```
```
 Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
 
```
    repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - hasFinishMessage
```
public boolean hasFinishMessage()
```
```
 Output only. Describes the reason the mode stopped generating tokens in
 more detail. This is only filled when `finish_reason` is set.
 
```
    optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    hasFinishMessage in interface CandidateOrBuilder
    
    Returns:
    
    Whether the finishMessage field is set.
  - getFinishMessage
```
public String getFinishMessage()
```
```
 Output only. Describes the reason the mode stopped generating tokens in
 more detail. This is only filled when `finish_reason` is set.
 
```
    optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getFinishMessage in interface CandidateOrBuilder
    
    Returns:
    
    The finishMessage.
  - getFinishMessageBytes
```
public com.google.protobuf.ByteString getFinishMessageBytes()
```
```
 Output only. Describes the reason the mode stopped generating tokens in
 more detail. This is only filled when `finish_reason` is set.
 
```
    optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getFinishMessageBytes in interface CandidateOrBuilder
    
    Returns:
    
    The bytes for finishMessage.
  - setFinishMessage
```
public Candidate.Builder setFinishMessage(String value)
```
```
 Output only. Describes the reason the mode stopped generating tokens in
 more detail. This is only filled when `finish_reason` is set.
 
```
    optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Parameters:
    
    value - The finishMessage to set.
    
    Returns:
    
    This builder for chaining.
  - clearFinishMessage
```
public Candidate.Builder clearFinishMessage()
```
```
 Output only. Describes the reason the mode stopped generating tokens in
 more detail. This is only filled when `finish_reason` is set.
 
```
    optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    This builder for chaining.
  - setFinishMessageBytes
```
public Candidate.Builder setFinishMessageBytes(com.google.protobuf.ByteString value)
```
```
 Output only. Describes the reason the mode stopped generating tokens in
 more detail. This is only filled when `finish_reason` is set.
 
```
    optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Parameters:
    
    value - The bytes for finishMessage to set.
    
    Returns:
    
    This builder for chaining.
  - hasCitationMetadata
```
public boolean hasCitationMetadata()
```
```
 Output only. Source attribution of the generated content.
 
```
    .google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    hasCitationMetadata in interface CandidateOrBuilder
    
    Returns:
    
    Whether the citationMetadata field is set.
  - getCitationMetadata
```
public CitationMetadata getCitationMetadata()
```
```
 Output only. Source attribution of the generated content.
 
```
    .google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getCitationMetadata in interface CandidateOrBuilder
    
    Returns:
    
    The citationMetadata.
  - setCitationMetadata
```
public Candidate.Builder setCitationMetadata(CitationMetadata value)
```
```
 Output only. Source attribution of the generated content.
 
```
    .google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - setCitationMetadata
```
public Candidate.Builder setCitationMetadata(CitationMetadata.Builder builderForValue)
```
```
 Output only. Source attribution of the generated content.
 
```
    .google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - mergeCitationMetadata
```
public Candidate.Builder mergeCitationMetadata(CitationMetadata value)
```
```
 Output only. Source attribution of the generated content.
 
```
    .google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - clearCitationMetadata
```
public Candidate.Builder clearCitationMetadata()
```
```
 Output only. Source attribution of the generated content.
 
```
    .google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getCitationMetadataBuilder
```
public CitationMetadata.Builder getCitationMetadataBuilder()
```
```
 Output only. Source attribution of the generated content.
 
```
    .google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getCitationMetadataOrBuilder
```
public CitationMetadataOrBuilder getCitationMetadataOrBuilder()
```
```
 Output only. Source attribution of the generated content.
 
```
    .google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getCitationMetadataOrBuilder in interface CandidateOrBuilder
  - hasGroundingMetadata
```
public boolean hasGroundingMetadata()
```
```
 Output only. Metadata specifies sources used to ground generated content.
 
```
    .google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    hasGroundingMetadata in interface CandidateOrBuilder
    
    Returns:
    
    Whether the groundingMetadata field is set.
  - getGroundingMetadata
```
public GroundingMetadata getGroundingMetadata()
```
```
 Output only. Metadata specifies sources used to ground generated content.
 
```
    .google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getGroundingMetadata in interface CandidateOrBuilder
    
    Returns:
    
    The groundingMetadata.
  - setGroundingMetadata
```
public Candidate.Builder setGroundingMetadata(GroundingMetadata value)
```
```
 Output only. Metadata specifies sources used to ground generated content.
 
```
    .google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - setGroundingMetadata
```
public Candidate.Builder setGroundingMetadata(GroundingMetadata.Builder builderForValue)
```
```
 Output only. Metadata specifies sources used to ground generated content.
 
```
    .google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - mergeGroundingMetadata
```
public Candidate.Builder mergeGroundingMetadata(GroundingMetadata value)
```
```
 Output only. Metadata specifies sources used to ground generated content.
 
```
    .google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - clearGroundingMetadata
```
public Candidate.Builder clearGroundingMetadata()
```
```
 Output only. Metadata specifies sources used to ground generated content.
 
```
    .google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getGroundingMetadataBuilder
```
public GroundingMetadata.Builder getGroundingMetadataBuilder()
```
```
 Output only. Metadata specifies sources used to ground generated content.
 
```
    .google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getGroundingMetadataOrBuilder
```
public GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()
```
```
 Output only. Metadata specifies sources used to ground generated content.
 
```
    .google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getGroundingMetadataOrBuilder in interface CandidateOrBuilder
  - setUnknownFields
```
public final Candidate.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>
  - mergeUnknownFields
```
public final Candidate.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Candidate.Builder>

Class Candidate.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getIndex

setIndex

clearIndex

hasContent

getContent

setContent

setContent

mergeContent

clearContent

getContentBuilder

getContentOrBuilder

getScore

setScore

clearScore

getAvgLogprobs

setAvgLogprobs

clearAvgLogprobs

getFinishReasonValue

setFinishReasonValue

getFinishReason

setFinishReason

clearFinishReason

getSafetyRatingsList

getSafetyRatingsCount

getSafetyRatings

setSafetyRatings

setSafetyRatings

addSafetyRatings

addSafetyRatings

addSafetyRatings

addSafetyRatings

addAllSafetyRatings

clearSafetyRatings

removeSafetyRatings

getSafetyRatingsBuilder

getSafetyRatingsOrBuilder

getSafetyRatingsOrBuilderList

addSafetyRatingsBuilder

addSafetyRatingsBuilder

getSafetyRatingsBuilderList

hasFinishMessage

getFinishMessage

getFinishMessageBytes

setFinishMessage

clearFinishMessage

setFinishMessageBytes

hasCitationMetadata

getCitationMetadata

setCitationMetadata

setCitationMetadata

mergeCitationMetadata

clearCitationMetadata

getCitationMetadataBuilder

getCitationMetadataOrBuilder