Class GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder (0.51.0)

public static final class GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder extends GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder> implements GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadataOrBuilder

Describes the metadata associated with a retrieval step.

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

Inheritance

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder
Overrides

build()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata build()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata

buildPartial()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata buildPartial()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata

clear()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder clear()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder
Overrides

clearDynamicRetrievalMetadata()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder clearDynamicRetrievalMetadata()

Metadata for dynamic retrieval.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;

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

clearField(Descriptors.FieldDescriptor field)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder
Overrides

clearSource()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder clearSource()

Describes the source to which the metadata is referring to.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1;

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

This builder for chaining.

clone()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder clone()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder
Overrides

getDefaultInstanceForType()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata getDefaultInstanceForType()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDynamicRetrievalMetadata()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata getDynamicRetrievalMetadata()

Metadata for dynamic retrieval.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;

Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata

The dynamicRetrievalMetadata.

getDynamicRetrievalMetadataBuilder()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata.Builder getDynamicRetrievalMetadataBuilder()

Metadata for dynamic retrieval.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;

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

getDynamicRetrievalMetadataOrBuilder()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadataOrBuilder getDynamicRetrievalMetadataOrBuilder()

Metadata for dynamic retrieval.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;

Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadataOrBuilder

getSource()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source getSource()

Describes the source to which the metadata is referring to.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1;

Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source

The source.

getSourceValue()

public int getSourceValue()

Describes the source to which the metadata is referring to.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1;

Returns
Type Description
int

The enum numeric value on the wire for source.

hasDynamicRetrievalMetadata()

public boolean hasDynamicRetrievalMetadata()

Metadata for dynamic retrieval.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;

Returns
Type Description
boolean

Whether the dynamicRetrievalMetadata field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDynamicRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder mergeDynamicRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata value)

Metadata for dynamic retrieval.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;

Parameter
Name Description
value GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder

mergeFrom(GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata other)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder mergeFrom(GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata other)
Parameter
Name Description
other GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder
Overrides

setDynamicRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder setDynamicRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata value)

Metadata for dynamic retrieval.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;

Parameter
Name Description
value GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder

setDynamicRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder setDynamicRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata.Builder builderForValue)

Metadata for dynamic retrieval.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata dynamic_retrieval_metadata = 2;

Parameter
Name Description
builderForValue GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalMetadata.Builder
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder
Overrides

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

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder
Overrides

setSource(GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder setSource(GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source value)

Describes the source to which the metadata is referring to.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1;

Parameter
Name Description
value GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source

The source to set.

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

This builder for chaining.

setSourceValue(int value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder setSourceValue(int value)

Describes the source to which the metadata is referring to.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Source source = 1;

Parameter
Name Description
value int

The enum numeric value on the wire for source to set.

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

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder
Overrides