Package com.google.cloud.aiplatform.v1

Class FindNeighborsResponse.Neighbor

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.aiplatform.v1.FindNeighborsResponse.Neighbor

All Implemented Interfaces:

FindNeighborsResponse.NeighborOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

FindNeighborsResponse

public static final class FindNeighborsResponse.Neighbor
extends com.google.protobuf.GeneratedMessage
implements FindNeighborsResponse.NeighborOrBuilder

 A neighbor of the query vector.
 

Protobuf type google.cloud.aiplatform.v1.FindNeighborsResponse.Neighbor

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FindNeighborsResponse.Neighbor.Builder	A neighbor of the query vector.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DATAPOINT_FIELD_NUMBER
static final int	DISTANCE_FIELD_NUMBER
static final int	SPARSE_DISTANCE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
IndexDatapoint	getDatapoint()	The datapoint of the neighbor.
IndexDatapointOrBuilder	getDatapointOrBuilder()	The datapoint of the neighbor.
static FindNeighborsResponse.Neighbor	getDefaultInstance()
FindNeighborsResponse.Neighbor	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
double	getDistance()	The distance between the neighbor and the dense embedding query.
com.google.protobuf.Parser<FindNeighborsResponse.Neighbor>	getParserForType()
int	getSerializedSize()
double	getSparseDistance()	The distance between the neighbor and the query sparse_embedding.
boolean	hasDatapoint()	The datapoint of the neighbor.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static FindNeighborsResponse.Neighbor.Builder	newBuilder()
static FindNeighborsResponse.Neighbor.Builder	newBuilder(FindNeighborsResponse.Neighbor prototype)
FindNeighborsResponse.Neighbor.Builder	newBuilderForType()
protected FindNeighborsResponse.Neighbor.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static FindNeighborsResponse.Neighbor	parseDelimitedFrom(InputStream input)
static FindNeighborsResponse.Neighbor	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsResponse.Neighbor	parseFrom(byte[] data)
static FindNeighborsResponse.Neighbor	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsResponse.Neighbor	parseFrom(com.google.protobuf.ByteString data)
static FindNeighborsResponse.Neighbor	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsResponse.Neighbor	parseFrom(com.google.protobuf.CodedInputStream input)
static FindNeighborsResponse.Neighbor	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsResponse.Neighbor	parseFrom(InputStream input)
static FindNeighborsResponse.Neighbor	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsResponse.Neighbor	parseFrom(ByteBuffer data)
static FindNeighborsResponse.Neighbor	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FindNeighborsResponse.Neighbor>	parser()
FindNeighborsResponse.Neighbor.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

DATAPOINT_FIELD_NUMBER

public static final int DATAPOINT_FIELD_NUMBER

See Also:

• Constant Field Values

DISTANCE_FIELD_NUMBER

public static final int DISTANCE_FIELD_NUMBER

See Also:

• Constant Field Values

SPARSE_DISTANCE_FIELD_NUMBER

public static final int SPARSE_DISTANCE_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

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

hasDatapoint

public boolean hasDatapoint()

 The datapoint of the neighbor.
 Note that full datapoints are returned only when "return_full_datapoint"
 is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
 fields are populated.
 

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;

Specified by:

hasDatapoint in interface FindNeighborsResponse.NeighborOrBuilder

Returns:

Whether the datapoint field is set.

getDatapoint

public IndexDatapoint getDatapoint()

 The datapoint of the neighbor.
 Note that full datapoints are returned only when "return_full_datapoint"
 is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
 fields are populated.
 

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;

Specified by:

getDatapoint in interface FindNeighborsResponse.NeighborOrBuilder

Returns:

The datapoint.

getDatapointOrBuilder

public IndexDatapointOrBuilder getDatapointOrBuilder()

 The datapoint of the neighbor.
 Note that full datapoints are returned only when "return_full_datapoint"
 is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
 fields are populated.
 

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;

Specified by:

getDatapointOrBuilder in interface FindNeighborsResponse.NeighborOrBuilder

getDistance

public double getDistance()

 The distance between the neighbor and the dense embedding query.
 

double distance = 2;

Specified by:

getDistance in interface FindNeighborsResponse.NeighborOrBuilder

Returns:

The distance.

getSparseDistance

public double getSparseDistance()

 The distance between the neighbor and the query sparse_embedding.
 

double sparse_distance = 3;

Specified by:

getSparseDistance in interface FindNeighborsResponse.NeighborOrBuilder

Returns:

The sparseDistance.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static FindNeighborsResponse.Neighbor parseFrom(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsResponse.Neighbor parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsResponse.Neighbor parseFrom(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsResponse.Neighbor parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsResponse.Neighbor parseFrom(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsResponse.Neighbor parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsResponse.Neighbor parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static FindNeighborsResponse.Neighbor parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static FindNeighborsResponse.Neighbor parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static FindNeighborsResponse.Neighbor parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseFrom

public static FindNeighborsResponse.Neighbor parseFrom(com.google.protobuf.CodedInputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static FindNeighborsResponse.Neighbor parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

newBuilderForType

public FindNeighborsResponse.Neighbor.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FindNeighborsResponse.Neighbor.Builder newBuilder()

newBuilder

public static FindNeighborsResponse.Neighbor.Builder newBuilder(FindNeighborsResponse.Neighbor prototype)

toBuilder

public FindNeighborsResponse.Neighbor.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FindNeighborsResponse.Neighbor.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static FindNeighborsResponse.Neighbor getDefaultInstance()

parser

public static com.google.protobuf.Parser<FindNeighborsResponse.Neighbor> parser()

getParserForType

public com.google.protobuf.Parser<FindNeighborsResponse.Neighbor> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public FindNeighborsResponse.Neighbor getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder