FindNeighborsRequest.Query.RRF.Builder (proto-google-cloud-aiplatform-v1 3.86.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<FindNeighborsRequest.Query.RRF.Builder>
    - - com.google.cloud.aiplatform.v1.FindNeighborsRequest.Query.RRF.Builder

All Implemented Interfaces:

FindNeighborsRequest.Query.RRFOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

FindNeighborsRequest.Query.RRF
```
public static final class FindNeighborsRequest.Query.RRF.Builder
extends com.google.protobuf.GeneratedMessage.Builder<FindNeighborsRequest.Query.RRF.Builder>
implements FindNeighborsRequest.Query.RRFOrBuilder
```
```
 Parameters for RRF algorithm that combines search results.
 
```
Protobuf type google.cloud.aiplatform.v1.FindNeighborsRequest.Query.RRF

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FindNeighborsRequest.Query.RRF`	`build()`
`FindNeighborsRequest.Query.RRF`	`buildPartial()`
`FindNeighborsRequest.Query.RRF.Builder`	`clear()`
`FindNeighborsRequest.Query.RRF.Builder`	`clearAlpha()` Required.
`float`	`getAlpha()` Required.
`FindNeighborsRequest.Query.RRF`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`FindNeighborsRequest.Query.RRF.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`FindNeighborsRequest.Query.RRF.Builder`	`mergeFrom(FindNeighborsRequest.Query.RRF other)`
`FindNeighborsRequest.Query.RRF.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`FindNeighborsRequest.Query.RRF.Builder`	`setAlpha(float value)` Required.

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.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

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

- Method Detail
  - 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<FindNeighborsRequest.Query.RRF.Builder>
  - clear
```
public FindNeighborsRequest.Query.RRF.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<FindNeighborsRequest.Query.RRF.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<FindNeighborsRequest.Query.RRF.Builder>
  - getDefaultInstanceForType
```
public FindNeighborsRequest.Query.RRF getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public FindNeighborsRequest.Query.RRF build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public FindNeighborsRequest.Query.RRF buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public FindNeighborsRequest.Query.RRF.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<FindNeighborsRequest.Query.RRF.Builder>
  - mergeFrom
```
public FindNeighborsRequest.Query.RRF.Builder mergeFrom(FindNeighborsRequest.Query.RRF other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<FindNeighborsRequest.Query.RRF.Builder>
  - mergeFrom
```
public FindNeighborsRequest.Query.RRF.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<FindNeighborsRequest.Query.RRF.Builder>
    
    Throws:
    
    IOException
  - getAlpha
```
public float getAlpha()
```
```
 Required. Users can provide an alpha value to give more weight to dense
 vs sparse results. For example, if the alpha is 0, we only return
 sparse and if the alpha is 1, we only return dense.
 
```
    float alpha = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getAlpha in interface FindNeighborsRequest.Query.RRFOrBuilder
    
    Returns:
    
    The alpha.
  - setAlpha
```
public FindNeighborsRequest.Query.RRF.Builder setAlpha(float value)
```
```
 Required. Users can provide an alpha value to give more weight to dense
 vs sparse results. For example, if the alpha is 0, we only return
 sparse and if the alpha is 1, we only return dense.
 
```
    float alpha = 1 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The alpha to set.
    
    Returns:
    
    This builder for chaining.
  - clearAlpha
```
public FindNeighborsRequest.Query.RRF.Builder clearAlpha()
```
```
 Required. Users can provide an alpha value to give more weight to dense
 vs sparse results. For example, if the alpha is 0, we only return
 sparse and if the alpha is 1, we only return dense.
 
```
    float alpha = 1 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    This builder for chaining.

Class FindNeighborsRequest.Query.RRF.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.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

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getAlpha

setAlpha

clearAlpha