Package com.google.cloud.discoveryengine.v1beta

Class GenerateGroundedContentResponse.Candidate.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<GenerateGroundedContentResponse.Candidate.Builder>

com.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.Builder

All Implemented Interfaces:

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

Enclosing class:

GenerateGroundedContentResponse.Candidate

public static final class GenerateGroundedContentResponse.Candidate.Builder
extends com.google.protobuf.GeneratedMessage.Builder<GenerateGroundedContentResponse.Candidate.Builder>
implements GenerateGroundedContentResponse.CandidateOrBuilder

 A response candidate generated from the model.
 

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

Method Summary

Modifier and Type	Method	Description
GenerateGroundedContentResponse.Candidate	build()
GenerateGroundedContentResponse.Candidate	buildPartial()
GenerateGroundedContentResponse.Candidate.Builder	clear()
GenerateGroundedContentResponse.Candidate.Builder	clearContent()	Content of the candidate.
GenerateGroundedContentResponse.Candidate.Builder	clearGroundingMetadata()	Grounding metadata for the generated content.
GenerateGroundedContentResponse.Candidate.Builder	clearGroundingScore()	The overall grounding score for the candidate, in the range of [0, 1].
GenerateGroundedContentResponse.Candidate.Builder	clearIndex()	Index of the candidate.
GroundedGenerationContent	getContent()	Content of the candidate.
GroundedGenerationContent.Builder	getContentBuilder()	Content of the candidate.
GroundedGenerationContentOrBuilder	getContentOrBuilder()	Content of the candidate.
GenerateGroundedContentResponse.Candidate	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
GenerateGroundedContentResponse.Candidate.GroundingMetadata	getGroundingMetadata()	Grounding metadata for the generated content.
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder	getGroundingMetadataBuilder()	Grounding metadata for the generated content.
GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder	getGroundingMetadataOrBuilder()	Grounding metadata for the generated content.
float	getGroundingScore()	The overall grounding score for the candidate, in the range of [0, 1].
int	getIndex()	Index of the candidate.
boolean	hasContent()	Content of the candidate.
boolean	hasGroundingMetadata()	Grounding metadata for the generated content.
boolean	hasGroundingScore()	The overall grounding score for the candidate, in the range of [0, 1].
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
GenerateGroundedContentResponse.Candidate.Builder	mergeContent(GroundedGenerationContent value)	Content of the candidate.
GenerateGroundedContentResponse.Candidate.Builder	mergeFrom(GenerateGroundedContentResponse.Candidate other)
GenerateGroundedContentResponse.Candidate.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
GenerateGroundedContentResponse.Candidate.Builder	mergeFrom(com.google.protobuf.Message other)
GenerateGroundedContentResponse.Candidate.Builder	mergeGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)	Grounding metadata for the generated content.
GenerateGroundedContentResponse.Candidate.Builder	setContent(GroundedGenerationContent value)	Content of the candidate.
GenerateGroundedContentResponse.Candidate.Builder	setContent(GroundedGenerationContent.Builder builderForValue)	Content of the candidate.
GenerateGroundedContentResponse.Candidate.Builder	setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)	Grounding metadata for the generated content.
GenerateGroundedContentResponse.Candidate.Builder	setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder builderForValue)	Grounding metadata for the generated content.
GenerateGroundedContentResponse.Candidate.Builder	setGroundingScore(float value)	The overall grounding score for the candidate, in the range of [0, 1].
GenerateGroundedContentResponse.Candidate.Builder	setIndex(int value)	Index of the candidate.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<GenerateGroundedContentResponse.Candidate.Builder>

clear

public GenerateGroundedContentResponse.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.GeneratedMessage.Builder<GenerateGroundedContentResponse.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.GeneratedMessage.Builder<GenerateGroundedContentResponse.Candidate.Builder>

getDefaultInstanceForType

public GenerateGroundedContentResponse.Candidate getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public GenerateGroundedContentResponse.Candidate build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public GenerateGroundedContentResponse.Candidate buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public GenerateGroundedContentResponse.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<GenerateGroundedContentResponse.Candidate.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<GenerateGroundedContentResponse.Candidate.Builder>

mergeFrom

public GenerateGroundedContentResponse.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<GenerateGroundedContentResponse.Candidate.Builder>

Throws:

IOException

getIndex

public int getIndex()

 Index of the candidate.
 

int32 index = 1;

Specified by:

getIndex in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

The index.

setIndex

public GenerateGroundedContentResponse.Candidate.Builder setIndex(int value)

 Index of the candidate.
 

int32 index = 1;

Parameters:

value - The index to set.

Returns:

This builder for chaining.

clearIndex

public GenerateGroundedContentResponse.Candidate.Builder clearIndex()

 Index of the candidate.
 

int32 index = 1;

Returns:

This builder for chaining.

hasContent

public boolean hasContent()

 Content of the candidate.
 

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

Specified by:

hasContent in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

Whether the content field is set.

getContent

public GroundedGenerationContent getContent()

 Content of the candidate.
 

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

Specified by:

getContent in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

The content.

setContent

public GenerateGroundedContentResponse.Candidate.Builder setContent(GroundedGenerationContent value)

 Content of the candidate.
 

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

setContent

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

 Content of the candidate.
 

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

mergeContent

public GenerateGroundedContentResponse.Candidate.Builder mergeContent(GroundedGenerationContent value)

 Content of the candidate.
 

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

clearContent

public GenerateGroundedContentResponse.Candidate.Builder clearContent()

 Content of the candidate.
 

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

getContentBuilder

public GroundedGenerationContent.Builder getContentBuilder()

 Content of the candidate.
 

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

getContentOrBuilder

public GroundedGenerationContentOrBuilder getContentOrBuilder()

 Content of the candidate.
 

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

Specified by:

getContentOrBuilder in interface GenerateGroundedContentResponse.CandidateOrBuilder

hasGroundingScore

public boolean hasGroundingScore()

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

optional float grounding_score = 3;

Specified by:

hasGroundingScore in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

Whether the groundingScore field is set.

getGroundingScore

public float getGroundingScore()

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

optional float grounding_score = 3;

Specified by:

getGroundingScore in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

The groundingScore.

setGroundingScore

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;

Parameters:

value - The groundingScore to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

hasGroundingMetadata

public boolean hasGroundingMetadata()

 Grounding metadata for the generated content.
 

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

Specified by:

hasGroundingMetadata in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

Whether the groundingMetadata field is set.

getGroundingMetadata

public GenerateGroundedContentResponse.Candidate.GroundingMetadata getGroundingMetadata()

 Grounding metadata for the generated content.
 

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

Specified by:

getGroundingMetadata in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

The groundingMetadata.

setGroundingMetadata

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

 Grounding metadata for the generated content.
 

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

setGroundingMetadata

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

 Grounding metadata for the generated content.
 

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

mergeGroundingMetadata

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

 Grounding metadata for the generated content.
 

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

clearGroundingMetadata

public GenerateGroundedContentResponse.Candidate.Builder clearGroundingMetadata()

 Grounding metadata for the generated content.
 

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

getGroundingMetadataBuilder

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder getGroundingMetadataBuilder()

 Grounding metadata for the generated content.
 

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

getGroundingMetadataOrBuilder

public GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()

 Grounding metadata for the generated content.
 

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

Specified by:

getGroundingMetadataOrBuilder in interface GenerateGroundedContentResponse.CandidateOrBuilder