NearestNeighborQuery.Parameters.Builder (proto-google-cloud-aiplatform-v1 3.44.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.Parameters.Builder>
    - - com.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters.Builder

All Implemented Interfaces:

NearestNeighborQuery.ParametersOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

NearestNeighborQuery.Parameters
```
public static final class NearestNeighborQuery.Parameters.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.Parameters.Builder>
implements NearestNeighborQuery.ParametersOrBuilder
```
```
 Parameters that can be overrided in each query to tune query latency and
 recall.
 
```
Protobuf type google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NearestNeighborQuery.Parameters.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`NearestNeighborQuery.Parameters`	`build()`
`NearestNeighborQuery.Parameters`	`buildPartial()`
`NearestNeighborQuery.Parameters.Builder`	`clear()`
`NearestNeighborQuery.Parameters.Builder`	`clearApproximateNeighborCandidates()` Optional.
`NearestNeighborQuery.Parameters.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`NearestNeighborQuery.Parameters.Builder`	`clearLeafNodesSearchFraction()` Optional.
`NearestNeighborQuery.Parameters.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`NearestNeighborQuery.Parameters.Builder`	`clone()`
`int`	`getApproximateNeighborCandidates()` Optional.
`NearestNeighborQuery.Parameters`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`double`	`getLeafNodesSearchFraction()` Optional.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`NearestNeighborQuery.Parameters.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`NearestNeighborQuery.Parameters.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`NearestNeighborQuery.Parameters.Builder`	`mergeFrom(NearestNeighborQuery.Parameters other)`
`NearestNeighborQuery.Parameters.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`NearestNeighborQuery.Parameters.Builder`	`setApproximateNeighborCandidates(int value)` Optional.
`NearestNeighborQuery.Parameters.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`NearestNeighborQuery.Parameters.Builder`	`setLeafNodesSearchFraction(double value)` Optional.
`NearestNeighborQuery.Parameters.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`NearestNeighborQuery.Parameters.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

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<NearestNeighborQuery.Parameters.Builder>
  - clear
```
public NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.Builder>
  - getDefaultInstanceForType
```
public NearestNeighborQuery.Parameters getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public NearestNeighborQuery.Parameters build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public NearestNeighborQuery.Parameters buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.Builder>
  - setField
```
public NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.Builder>
  - clearField
```
public NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.Builder>
  - clearOneof
```
public NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.Builder>
  - setRepeatedField
```
public NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.Builder>
  - addRepeatedField
```
public NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.Builder>
  - mergeFrom
```
public NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.Builder>
  - mergeFrom
```
public NearestNeighborQuery.Parameters.Builder mergeFrom(NearestNeighborQuery.Parameters other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<NearestNeighborQuery.Parameters.Builder>
  - mergeFrom
```
public NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.Builder>
    
    Throws:
    
    IOException
  - getApproximateNeighborCandidates
```
public int getApproximateNeighborCandidates()
```
```
 Optional. The number of neighbors to find via approximate search before
 exact reordering is performed; if set, this value must be >
 neighbor_count.
 
```
    int32 approximate_neighbor_candidates = 1 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getApproximateNeighborCandidates in interface NearestNeighborQuery.ParametersOrBuilder
    
    Returns:
    
    The approximateNeighborCandidates.
  - setApproximateNeighborCandidates
```
public NearestNeighborQuery.Parameters.Builder setApproximateNeighborCandidates(int value)
```
```
 Optional. The number of neighbors to find via approximate search before
 exact reordering is performed; if set, this value must be >
 neighbor_count.
 
```
    int32 approximate_neighbor_candidates = 1 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The approximateNeighborCandidates to set.
    
    Returns:
    
    This builder for chaining.
  - clearApproximateNeighborCandidates
```
public NearestNeighborQuery.Parameters.Builder clearApproximateNeighborCandidates()
```
```
 Optional. The number of neighbors to find via approximate search before
 exact reordering is performed; if set, this value must be >
 neighbor_count.
 
```
    int32 approximate_neighbor_candidates = 1 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - getLeafNodesSearchFraction
```
public double getLeafNodesSearchFraction()
```
```
 Optional. The fraction of the number of leaves to search, set at query
 time allows user to tune search performance. This value increase result
 in both search accuracy and latency increase. The value should be between
 0.0 and 1.0.
 
```
    double leaf_nodes_search_fraction = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getLeafNodesSearchFraction in interface NearestNeighborQuery.ParametersOrBuilder
    
    Returns:
    
    The leafNodesSearchFraction.
  - setLeafNodesSearchFraction
```
public NearestNeighborQuery.Parameters.Builder setLeafNodesSearchFraction(double value)
```
```
 Optional. The fraction of the number of leaves to search, set at query
 time allows user to tune search performance. This value increase result
 in both search accuracy and latency increase. The value should be between
 0.0 and 1.0.
 
```
    double leaf_nodes_search_fraction = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The leafNodesSearchFraction to set.
    
    Returns:
    
    This builder for chaining.
  - clearLeafNodesSearchFraction
```
public NearestNeighborQuery.Parameters.Builder clearLeafNodesSearchFraction()
```
```
 Optional. The fraction of the number of leaves to search, set at query
 time allows user to tune search performance. This value increase result
 in both search accuracy and latency increase. The value should be between
 0.0 and 1.0.
 
```
    double leaf_nodes_search_fraction = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.Builder>
  - mergeUnknownFields
```
public final NearestNeighborQuery.Parameters.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<NearestNeighborQuery.Parameters.Builder>

Class NearestNeighborQuery.Parameters.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

getApproximateNeighborCandidates

setApproximateNeighborCandidates

clearApproximateNeighborCandidates

getLeafNodesSearchFraction

setLeafNodesSearchFraction

clearLeafNodesSearchFraction

setUnknownFields

mergeUnknownFields