LogprobsResult.TopCandidates.Builder (proto-google-cloud-vertexai-v1 1.22.0 API)

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

All Implemented Interfaces:

LogprobsResult.TopCandidatesOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

LogprobsResult.TopCandidates
```
public static final class LogprobsResult.TopCandidates.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LogprobsResult.TopCandidates.Builder>
implements LogprobsResult.TopCandidatesOrBuilder
```
```
 Candidates with top log probabilities at each decoding step.
 
```
Protobuf type google.cloud.vertexai.v1.LogprobsResult.TopCandidates

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LogprobsResult.TopCandidates.Builder`	`addAllCandidates(Iterable<? extends LogprobsResult.Candidate> values)` Sorted by log probability in descending order.
`LogprobsResult.TopCandidates.Builder`	`addCandidates(int index, LogprobsResult.Candidate.Builder builderForValue)` Sorted by log probability in descending order.
`LogprobsResult.TopCandidates.Builder`	`addCandidates(int index, LogprobsResult.Candidate value)` Sorted by log probability in descending order.
`LogprobsResult.TopCandidates.Builder`	`addCandidates(LogprobsResult.Candidate.Builder builderForValue)` Sorted by log probability in descending order.
`LogprobsResult.TopCandidates.Builder`	`addCandidates(LogprobsResult.Candidate value)` Sorted by log probability in descending order.
`LogprobsResult.Candidate.Builder`	`addCandidatesBuilder()` Sorted by log probability in descending order.
`LogprobsResult.Candidate.Builder`	`addCandidatesBuilder(int index)` Sorted by log probability in descending order.
`LogprobsResult.TopCandidates.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`LogprobsResult.TopCandidates`	`build()`
`LogprobsResult.TopCandidates`	`buildPartial()`
`LogprobsResult.TopCandidates.Builder`	`clear()`
`LogprobsResult.TopCandidates.Builder`	`clearCandidates()` Sorted by log probability in descending order.
`LogprobsResult.TopCandidates.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`LogprobsResult.TopCandidates.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`LogprobsResult.TopCandidates.Builder`	`clone()`
`LogprobsResult.Candidate`	`getCandidates(int index)` Sorted by log probability in descending order.
`LogprobsResult.Candidate.Builder`	`getCandidatesBuilder(int index)` Sorted by log probability in descending order.
`List<LogprobsResult.Candidate.Builder>`	`getCandidatesBuilderList()` Sorted by log probability in descending order.
`int`	`getCandidatesCount()` Sorted by log probability in descending order.
`List<LogprobsResult.Candidate>`	`getCandidatesList()` Sorted by log probability in descending order.
`LogprobsResult.CandidateOrBuilder`	`getCandidatesOrBuilder(int index)` Sorted by log probability in descending order.
`List<? extends LogprobsResult.CandidateOrBuilder>`	`getCandidatesOrBuilderList()` Sorted by log probability in descending order.
`LogprobsResult.TopCandidates`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`LogprobsResult.TopCandidates.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`LogprobsResult.TopCandidates.Builder`	`mergeFrom(LogprobsResult.TopCandidates other)`
`LogprobsResult.TopCandidates.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`LogprobsResult.TopCandidates.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`LogprobsResult.TopCandidates.Builder`	`removeCandidates(int index)` Sorted by log probability in descending order.
`LogprobsResult.TopCandidates.Builder`	`setCandidates(int index, LogprobsResult.Candidate.Builder builderForValue)` Sorted by log probability in descending order.
`LogprobsResult.TopCandidates.Builder`	`setCandidates(int index, LogprobsResult.Candidate value)` Sorted by log probability in descending order.
`LogprobsResult.TopCandidates.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`LogprobsResult.TopCandidates.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>
  - clear
```
public LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>
  - getDefaultInstanceForType
```
public LogprobsResult.TopCandidates getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public LogprobsResult.TopCandidates build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public LogprobsResult.TopCandidates buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>
  - setField
```
public LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>
  - clearField
```
public LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>
  - clearOneof
```
public LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>
  - setRepeatedField
```
public LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>
  - addRepeatedField
```
public LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>
  - mergeFrom
```
public LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>
  - mergeFrom
```
public LogprobsResult.TopCandidates.Builder mergeFrom(LogprobsResult.TopCandidates other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LogprobsResult.TopCandidates.Builder>
  - mergeFrom
```
public LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>
    
    Throws:
    
    IOException
  - getCandidatesList
```
public List<LogprobsResult.Candidate> getCandidatesList()
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
    Specified by:
    
    getCandidatesList in interface LogprobsResult.TopCandidatesOrBuilder
  - getCandidatesCount
```
public int getCandidatesCount()
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
    Specified by:
    
    getCandidatesCount in interface LogprobsResult.TopCandidatesOrBuilder
  - getCandidates
```
public LogprobsResult.Candidate getCandidates(int index)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
    Specified by:
    
    getCandidates in interface LogprobsResult.TopCandidatesOrBuilder
  - setCandidates
```
public LogprobsResult.TopCandidates.Builder setCandidates(int index,
                                                          LogprobsResult.Candidate value)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - setCandidates
```
public LogprobsResult.TopCandidates.Builder setCandidates(int index,
                                                          LogprobsResult.Candidate.Builder builderForValue)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - addCandidates
```
public LogprobsResult.TopCandidates.Builder addCandidates(LogprobsResult.Candidate value)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - addCandidates
```
public LogprobsResult.TopCandidates.Builder addCandidates(int index,
                                                          LogprobsResult.Candidate value)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - addCandidates
```
public LogprobsResult.TopCandidates.Builder addCandidates(LogprobsResult.Candidate.Builder builderForValue)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - addCandidates
```
public LogprobsResult.TopCandidates.Builder addCandidates(int index,
                                                          LogprobsResult.Candidate.Builder builderForValue)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - addAllCandidates
```
public LogprobsResult.TopCandidates.Builder addAllCandidates(Iterable<? extends LogprobsResult.Candidate> values)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - clearCandidates
```
public LogprobsResult.TopCandidates.Builder clearCandidates()
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - removeCandidates
```
public LogprobsResult.TopCandidates.Builder removeCandidates(int index)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - getCandidatesBuilder
```
public LogprobsResult.Candidate.Builder getCandidatesBuilder(int index)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - getCandidatesOrBuilder
```
public LogprobsResult.CandidateOrBuilder getCandidatesOrBuilder(int index)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
    Specified by:
    
    getCandidatesOrBuilder in interface LogprobsResult.TopCandidatesOrBuilder
  - getCandidatesOrBuilderList
```
public List<? extends LogprobsResult.CandidateOrBuilder> getCandidatesOrBuilderList()
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
    Specified by:
    
    getCandidatesOrBuilderList in interface LogprobsResult.TopCandidatesOrBuilder
  - addCandidatesBuilder
```
public LogprobsResult.Candidate.Builder addCandidatesBuilder()
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - addCandidatesBuilder
```
public LogprobsResult.Candidate.Builder addCandidatesBuilder(int index)
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - getCandidatesBuilderList
```
public List<LogprobsResult.Candidate.Builder> getCandidatesBuilderList()
```
```
 Sorted by log probability in descending order.
 
```
    repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
  - setUnknownFields
```
public final LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>
  - mergeUnknownFields
```
public final LogprobsResult.TopCandidates.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<LogprobsResult.TopCandidates.Builder>

Class LogprobsResult.TopCandidates.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

getCandidatesList

getCandidatesCount

getCandidates

setCandidates

setCandidates

addCandidates

addCandidates

addCandidates

addCandidates

addAllCandidates

clearCandidates

removeCandidates

getCandidatesBuilder

getCandidatesOrBuilder

getCandidatesOrBuilderList

addCandidatesBuilder

addCandidatesBuilder

getCandidatesBuilderList

setUnknownFields

mergeUnknownFields