Class LogprobsResult.Candidate.Builder (1.36.0)

Version latest

• 1.36.0 (latest)
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.30.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class LogprobsResult.Candidate.Builder extends GeneratedMessageV3.Builder<LogprobsResult.Candidate.Builder> implements LogprobsResult.CandidateOrBuilder

Candidate for the logprobs token and score.

Protobuf type google.cloud.vertexai.v1.LogprobsResult.Candidate

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > LogprobsResult.Candidate.Builder

Implements

LogprobsResult.CandidateOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LogprobsResult.Candidate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
LogprobsResult.Candidate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public LogprobsResult.Candidate build()

Returns
Type	Description
LogprobsResult.Candidate

buildPartial()

public LogprobsResult.Candidate buildPartial()

Returns
Type	Description
LogprobsResult.Candidate

clear()

public LogprobsResult.Candidate.Builder clear()

Returns
Type	Description
LogprobsResult.Candidate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public LogprobsResult.Candidate.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
LogprobsResult.Candidate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLogProbability()

public LogprobsResult.Candidate.Builder clearLogProbability()

The candidate's log probability.

optional float log_probability = 2;

Returns
Type	Description
LogprobsResult.Candidate.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LogprobsResult.Candidate.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
LogprobsResult.Candidate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearToken()

public LogprobsResult.Candidate.Builder clearToken()

The candidate’s token string value.

optional string token = 1;

Returns
Type	Description
LogprobsResult.Candidate.Builder	This builder for chaining.

clearTokenId()

public LogprobsResult.Candidate.Builder clearTokenId()

The candidate’s token id value.

optional int32 token_id = 3;

Returns
Type	Description
LogprobsResult.Candidate.Builder	This builder for chaining.

clone()

public LogprobsResult.Candidate.Builder clone()

Returns
Type	Description
LogprobsResult.Candidate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public LogprobsResult.Candidate getDefaultInstanceForType()

Returns
Type	Description
LogprobsResult.Candidate

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getLogProbability()

public float getLogProbability()

The candidate's log probability.

optional float log_probability = 2;

Returns
Type	Description
float	The logProbability.

getToken()

public String getToken()

The candidate’s token string value.

optional string token = 1;

Returns
Type	Description
String	The token.

getTokenBytes()

public ByteString getTokenBytes()

The candidate’s token string value.

optional string token = 1;

Returns
Type	Description
ByteString	The bytes for token.

getTokenId()

public int getTokenId()

The candidate’s token id value.

optional int32 token_id = 3;

Returns
Type	Description
int	The tokenId.

hasLogProbability()

public boolean hasLogProbability()

The candidate's log probability.

optional float log_probability = 2;

Returns
Type	Description
boolean	Whether the logProbability field is set.

hasToken()

public boolean hasToken()

The candidate’s token string value.

optional string token = 1;

Returns
Type	Description
boolean	Whether the token field is set.

hasTokenId()

public boolean hasTokenId()

The candidate’s token id value.

optional int32 token_id = 3;

Returns
Type	Description
boolean	Whether the tokenId field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(LogprobsResult.Candidate other)

public LogprobsResult.Candidate.Builder mergeFrom(LogprobsResult.Candidate other)

Parameter
Name	Description
other	LogprobsResult.Candidate

Returns
Type	Description
LogprobsResult.Candidate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LogprobsResult.Candidate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LogprobsResult.Candidate.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public LogprobsResult.Candidate.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
LogprobsResult.Candidate.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LogprobsResult.Candidate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
LogprobsResult.Candidate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public LogprobsResult.Candidate.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
LogprobsResult.Candidate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setLogProbability(float value)

public LogprobsResult.Candidate.Builder setLogProbability(float value)

The candidate's log probability.

optional float log_probability = 2;

Parameter
Name	Description
value	float The logProbability to set.

Returns
Type	Description
LogprobsResult.Candidate.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public LogprobsResult.Candidate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
LogprobsResult.Candidate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setToken(String value)

public LogprobsResult.Candidate.Builder setToken(String value)

The candidate’s token string value.

optional string token = 1;

Parameter
Name	Description
value	String The token to set.

Returns
Type	Description
LogprobsResult.Candidate.Builder	This builder for chaining.

setTokenBytes(ByteString value)

public LogprobsResult.Candidate.Builder setTokenBytes(ByteString value)

The candidate’s token string value.

optional string token = 1;

Parameter
Name	Description
value	ByteString The bytes for token to set.

Returns
Type	Description
LogprobsResult.Candidate.Builder	This builder for chaining.

setTokenId(int value)

public LogprobsResult.Candidate.Builder setTokenId(int value)

The candidate’s token id value.

optional int32 token_id = 3;

Parameter
Name	Description
value	int The tokenId to set.

Returns
Type	Description
LogprobsResult.Candidate.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final LogprobsResult.Candidate.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
LogprobsResult.Candidate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)