Class SearchResult.SearchResultMetadata.SearchDistance.Builder (0.21.0)

0.21.0 (latest) 0.17.0 0.16.0 0.15.0 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.1.0

public static final class SearchResult.SearchResultMetadata.SearchDistance.Builder extends GeneratedMessage.Builder<SearchResult.SearchResultMetadata.SearchDistance.Builder> implements SearchResult.SearchResultMetadata.SearchDistanceOrBuilder

The rank and distance of this data object within a single search of the batch.

Protobuf type google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.SearchDistance

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchResult.SearchResultMetadata.SearchDistance.Builder

Implements

SearchResult.SearchResultMetadata.SearchDistanceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public SearchResult.SearchResultMetadata.SearchDistance build()

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

buildPartial()

public SearchResult.SearchResultMetadata.SearchDistance buildPartial()

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

clear()

public SearchResult.SearchResultMetadata.SearchDistance.Builder clear()

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearDistance()

public SearchResult.SearchResultMetadata.SearchDistance.Builder clearDistance()

Output only. The similarity distance of this data object for the search.

double distance = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder	This builder for chaining.

clearRank()

public SearchResult.SearchResultMetadata.SearchDistance.Builder clearRank()

Output only. The order of this data object in the search's result list, starting at 1 for the top (best-ranked) result.

int32 rank = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder	This builder for chaining.

clearSearchIndex()

public SearchResult.SearchResultMetadata.SearchDistance.Builder clearSearchIndex()

Output only. The index of the search in the BatchSearchDataObjectsRequest.searches this distance corresponds to.

int32 search_index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder	This builder for chaining.

getDefaultInstanceForType()

public SearchResult.SearchResultMetadata.SearchDistance getDefaultInstanceForType()

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getDistance()

public double getDistance()

Output only. The similarity distance of this data object for the search.

double distance = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
double	The distance.

getRank()

public int getRank()

Output only. The order of this data object in the search's result list, starting at 1 for the top (best-ranked) result.

int32 rank = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The rank.

getSearchIndex()

public int getSearchIndex()

Output only. The index of the search in the BatchSearchDataObjectsRequest.searches this distance corresponds to.

int32 search_index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The searchIndex.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(SearchResult.SearchResultMetadata.SearchDistance other)

public SearchResult.SearchResultMetadata.SearchDistance.Builder mergeFrom(SearchResult.SearchResultMetadata.SearchDistance other)

Parameter
Name	Description
other	SearchResult.SearchResultMetadata.SearchDistance

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchResult.SearchResultMetadata.SearchDistance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchResult.SearchResultMetadata.SearchDistance.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setDistance(double value)

public SearchResult.SearchResultMetadata.SearchDistance.Builder setDistance(double value)

Output only. The similarity distance of this data object for the search.

double distance = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	double The distance to set.

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder	This builder for chaining.

setRank(int value)

public SearchResult.SearchResultMetadata.SearchDistance.Builder setRank(int value)

Output only. The order of this data object in the search's result list, starting at 1 for the top (best-ranked) result.

int32 rank = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	int The rank to set.

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder	This builder for chaining.

setSearchIndex(int value)

public SearchResult.SearchResultMetadata.SearchDistance.Builder setSearchIndex(int value)

Output only. The index of the search in the BatchSearchDataObjectsRequest.searches this distance corresponds to.

int32 search_index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	int The searchIndex to set.

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder	This builder for chaining.