GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder (proto-google-cloud-discoveryengine-v1beta 0.53.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder>
    - - com.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder

All Implemented Interfaces:

GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata
```
public static final class GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder>
implements GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadataOrBuilder
```
```
 Describes the metadata about the dynamic retrieval predictor.
 
```
Protobuf type google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata`	`build()`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata`	`buildPartial()`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`clear()`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`clearPrediction()` The value of the predictor.
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`clearVersion()` The version of the predictor which was used in dynamic retrieval.
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`clone()`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`float`	`getPrediction()` The value of the predictor.
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version`	`getVersion()` The version of the predictor which was used in dynamic retrieval.
`int`	`getVersionValue()` The version of the predictor which was used in dynamic retrieval.
`boolean`	`hasPrediction()` The value of the predictor.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`mergeFrom(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata other)`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`setPrediction(float value)` The value of the predictor.
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`setVersion(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version value)` The version of the predictor which was used in dynamic retrieval.
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder`	`setVersionValue(int value)` The version of the predictor which was used in dynamic retrieval.

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

clear
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.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<GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.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<GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder>

getDefaultInstanceForType
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata 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.GroundingMetadata.DynamicRetrievalPredictorMetadata buildPartial()
```
Specified by:

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

Specified by:

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

clone
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.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<GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder>

setField

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

clearField
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.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<GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder>

clearOneof
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.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<GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder>

setRepeatedField

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

addRepeatedField

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

mergeFrom
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.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.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder>

mergeFrom

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

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder>

mergeFrom

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.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.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder>
Throws:: IOException

getVersionValue
```
public int getVersionValue()
```
```
 The version of the predictor which was used in dynamic retrieval.
 
```
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version version = 1;
Specified by:

getVersionValue in interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadataOrBuilder

Returns:

The enum numeric value on the wire for version.

setVersionValue
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder setVersionValue(int value)
```
```
 The version of the predictor which was used in dynamic retrieval.
 
```
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version version = 1;
Parameters:

value - The enum numeric value on the wire for version to set.

Returns:

This builder for chaining.

getVersion
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version getVersion()
```
```
 The version of the predictor which was used in dynamic retrieval.
 
```
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version version = 1;
Specified by:

getVersion in interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadataOrBuilder

Returns:

The version.

setVersion

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder setVersion(GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version value)

 The version of the predictor which was used in dynamic retrieval.


 .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version version = 1;

Parameters:: value - The version to set.
Returns:: This builder for chaining.

clearVersion

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder clearVersion()

 The version of the predictor which was used in dynamic retrieval.


 .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version version = 1;

Returns:: This builder for chaining.

hasPrediction

public boolean hasPrediction()

 The value of the predictor. This should be between [0, 1] where
 a value of 0 means that the query would not benefit from grounding,
 while a value of 1.0 means that the query would benefit the most.
 In between values allow to differentiate between different usefulness
 scores for grounding.

optional float prediction = 2;

Specified by:: hasPrediction in interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadataOrBuilder
Returns:: Whether the prediction field is set.

getPrediction

public float getPrediction()

 The value of the predictor. This should be between [0, 1] where
 a value of 0 means that the query would not benefit from grounding,
 while a value of 1.0 means that the query would benefit the most.
 In between values allow to differentiate between different usefulness
 scores for grounding.

optional float prediction = 2;

Specified by:: getPrediction in interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadataOrBuilder
Returns:: The prediction.

setPrediction

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder setPrediction(float value)

 The value of the predictor. This should be between [0, 1] where
 a value of 0 means that the query would not benefit from grounding,
 while a value of 1.0 means that the query would benefit the most.
 In between values allow to differentiate between different usefulness
 scores for grounding.

optional float prediction = 2;

Parameters:: value - The prediction to set.
Returns:: This builder for chaining.

clearPrediction

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder clearPrediction()

 The value of the predictor. This should be between [0, 1] where
 a value of 0 means that the query would not benefit from grounding,
 while a value of 1.0 means that the query would benefit the most.
 In between values allow to differentiate between different usefulness
 scores for grounding.

optional float prediction = 2;

Returns:: This builder for chaining.

setUnknownFields
```
public final GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.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<GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder>

mergeUnknownFields
```
public final GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.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<GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder>

Class GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.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

getVersionValue

setVersionValue

getVersion

setVersion

clearVersion

hasPrediction

getPrediction

setPrediction

clearPrediction

setUnknownFields

mergeUnknownFields