Class SearchResult.SearchResultMetadata.SearchDistance (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 extends GeneratedMessage 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

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

Implements

SearchResult.SearchResultMetadata.SearchDistanceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DISTANCE_FIELD_NUMBER

public static final int DISTANCE_FIELD_NUMBER

Field Value
Type	Description
int

RANK_FIELD_NUMBER

public static final int RANK_FIELD_NUMBER

Field Value
Type	Description
int

SEARCH_INDEX_FIELD_NUMBER

public static final int SEARCH_INDEX_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SearchResult.SearchResultMetadata.SearchDistance getDefaultInstance()

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SearchResult.SearchResultMetadata.SearchDistance.Builder newBuilder()

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder

newBuilder(SearchResult.SearchResultMetadata.SearchDistance prototype)

public static SearchResult.SearchResultMetadata.SearchDistance.Builder newBuilder(SearchResult.SearchResultMetadata.SearchDistance prototype)

Parameter
Name	Description
prototype	SearchResult.SearchResultMetadata.SearchDistance

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder

parseDelimitedFrom(InputStream input)

public static SearchResult.SearchResultMetadata.SearchDistance parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResult.SearchResultMetadata.SearchDistance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SearchResult.SearchResultMetadata.SearchDistance parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResult.SearchResultMetadata.SearchDistance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResult.SearchResultMetadata.SearchDistance parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResult.SearchResultMetadata.SearchDistance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResult.SearchResultMetadata.SearchDistance parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResult.SearchResultMetadata.SearchDistance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SearchResult.SearchResultMetadata.SearchDistance parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResult.SearchResultMetadata.SearchDistance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SearchResult.SearchResultMetadata.SearchDistance parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResult.SearchResultMetadata.SearchDistance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SearchResult.SearchResultMetadata.SearchDistance> parser()

Returns
Type	Description
Parser<SearchDistance>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public SearchResult.SearchResultMetadata.SearchDistance getDefaultInstanceForType()

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance

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.

getParserForType()

public Parser<SearchResult.SearchResultMetadata.SearchDistance> getParserForType()

Returns
Type	Description
Parser<SearchDistance>

Overrides

GeneratedMessage.getParserForType()

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public SearchResult.SearchResultMetadata.SearchDistance.Builder newBuilderForType()

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchResult.SearchResultMetadata.SearchDistance.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public SearchResult.SearchResultMetadata.SearchDistance.Builder toBuilder()

Returns
Type	Description
SearchResult.SearchResultMetadata.SearchDistance.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException