Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class GenerateGroundedContentResponse.Candidate.Builder (0.56.0)

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

A response candidate generated from the model.

Protobuf type google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate

Inheritance

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

Implements

GenerateGroundedContentResponse.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 GenerateGroundedContentResponse.Candidate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

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

build()

public GenerateGroundedContentResponse.Candidate build()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

buildPartial()

public GenerateGroundedContentResponse.Candidate buildPartial()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

clear()

public GenerateGroundedContentResponse.Candidate.Builder clear()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearContent()

public GenerateGroundedContentResponse.Candidate.Builder clearContent()

Content of the candidate.

.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

clearField(Descriptors.FieldDescriptor field)

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

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

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

clearGroundingMetadata()

public GenerateGroundedContentResponse.Candidate.Builder clearGroundingMetadata()

Grounding metadata for the generated content.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

clearGroundingScore()

public GenerateGroundedContentResponse.Candidate.Builder clearGroundingScore()

The overall grounding score for the candidate, in the range of [0, 1].

optional float grounding_score = 3;

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`	This builder for chaining.

clearIndex()

public GenerateGroundedContentResponse.Candidate.Builder clearIndex()

Index of the candidate.

int32 index = 1;

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

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

clone()

public GenerateGroundedContentResponse.Candidate.Builder clone()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getContent()

public GroundedGenerationContent getContent()

Content of the candidate.

.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;

Returns
Type	Description
`GroundedGenerationContent`	The content.

getContentBuilder()

public GroundedGenerationContent.Builder getContentBuilder()

Content of the candidate.

.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;

Returns
Type	Description
`GroundedGenerationContent.Builder`

getContentOrBuilder()

public GroundedGenerationContentOrBuilder getContentOrBuilder()

Content of the candidate.

.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;

Returns
Type	Description
`GroundedGenerationContentOrBuilder`

getDefaultInstanceForType()

public GenerateGroundedContentResponse.Candidate getDefaultInstanceForType()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getGroundingMetadata()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata getGroundingMetadata()

Grounding metadata for the generated content.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`	The groundingMetadata.

getGroundingMetadataBuilder()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder getGroundingMetadataBuilder()

Grounding metadata for the generated content.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder`

getGroundingMetadataOrBuilder()

public GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()

Grounding metadata for the generated content.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder`

getGroundingScore()

public float getGroundingScore()

The overall grounding score for the candidate, in the range of [0, 1].

optional float grounding_score = 3;

Returns
Type	Description
`float`	The groundingScore.

getIndex()

public int getIndex()

Index of the candidate.

int32 index = 1;

Returns
Type	Description
`int`	The index.

hasContent()

public boolean hasContent()

Content of the candidate.

.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;

Returns
Type	Description
`boolean`	Whether the content field is set.

hasGroundingMetadata()

public boolean hasGroundingMetadata()

Grounding metadata for the generated content.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Returns
Type	Description
`boolean`	Whether the groundingMetadata field is set.

hasGroundingScore()

public boolean hasGroundingScore()

The overall grounding score for the candidate, in the range of [0, 1].

optional float grounding_score = 3;

Returns
Type	Description
`boolean`	Whether the groundingScore 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()

mergeContent(GroundedGenerationContent value)

public GenerateGroundedContentResponse.Candidate.Builder mergeContent(GroundedGenerationContent value)

Content of the candidate.

.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;

Parameter
Name	Description
`value`	`GroundedGenerationContent`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

mergeFrom(GenerateGroundedContentResponse.Candidate other)

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

Parameter
Name	Description
`other`	`GenerateGroundedContentResponse.Candidate`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public GenerateGroundedContentResponse.Candidate.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

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

mergeGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)

public GenerateGroundedContentResponse.Candidate.Builder mergeGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)

Grounding metadata for the generated content.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Parameter
Name	Description
`value`	`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

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

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

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

setContent(GroundedGenerationContent value)

public GenerateGroundedContentResponse.Candidate.Builder setContent(GroundedGenerationContent value)

Content of the candidate.

.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;

Parameter
Name	Description
`value`	`GroundedGenerationContent`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

setContent(GroundedGenerationContent.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.Builder setContent(GroundedGenerationContent.Builder builderForValue)

Content of the candidate.

.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;

Parameter
Name	Description
`builderForValue`	`GroundedGenerationContent.Builder`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

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

setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)

public GenerateGroundedContentResponse.Candidate.Builder setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)

Grounding metadata for the generated content.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Parameter
Name	Description
`value`	`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.Builder setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder builderForValue)

Grounding metadata for the generated content.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Parameter
Name	Description
`builderForValue`	`GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

setGroundingScore(float value)

public GenerateGroundedContentResponse.Candidate.Builder setGroundingScore(float value)

The overall grounding score for the candidate, in the range of [0, 1].

optional float grounding_score = 3;

Parameter
Name	Description
`value`	`float` The groundingScore to set.

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`	This builder for chaining.

setIndex(int value)

public GenerateGroundedContentResponse.Candidate.Builder setIndex(int value)

Index of the candidate.

int32 index = 1;

Parameter
Name	Description
`value`	`int` The index to set.

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

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

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

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