Class FindNeighborsResponse.Neighbor (3.46.0)

public static final class FindNeighborsResponse.Neighbor extends GeneratedMessageV3 implements FindNeighborsResponse.NeighborOrBuilder

A neighbor of the query vector.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FindNeighborsResponse.Neighbor

Static Fields

DATAPOINT_FIELD_NUMBER

public static final int DATAPOINT_FIELD_NUMBER
Field Value
Type Description
int

DISTANCE_FIELD_NUMBER

public static final int DISTANCE_FIELD_NUMBER
Field Value
Type Description
int

SPARSE_DISTANCE_FIELD_NUMBER

public static final int SPARSE_DISTANCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FindNeighborsResponse.Neighbor getDefaultInstance()
Returns
Type Description
FindNeighborsResponse.Neighbor

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FindNeighborsResponse.Neighbor.Builder newBuilder()
Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

newBuilder(FindNeighborsResponse.Neighbor prototype)

public static FindNeighborsResponse.Neighbor.Builder newBuilder(FindNeighborsResponse.Neighbor prototype)
Parameter
Name Description
prototype FindNeighborsResponse.Neighbor
Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

parseDelimitedFrom(InputStream input)

public static FindNeighborsResponse.Neighbor parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsResponse.Neighbor parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FindNeighborsResponse.Neighbor parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsResponse.Neighbor parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FindNeighborsResponse.Neighbor parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsResponse.Neighbor parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FindNeighborsResponse.Neighbor parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsResponse.Neighbor parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FindNeighborsResponse.Neighbor parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsResponse.Neighbor parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FindNeighborsResponse.Neighbor parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsResponse.Neighbor parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsResponse.Neighbor
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FindNeighborsResponse.Neighbor> parser()
Returns
Type Description
Parser<Neighbor>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.v1beta1.IndexDatapoint datapoint = 1;

Returns
Type Description
IndexDatapoint

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.v1beta1.IndexDatapoint datapoint = 1;

Returns
Type Description
IndexDatapointOrBuilder

getDefaultInstanceForType()

public FindNeighborsResponse.Neighbor getDefaultInstanceForType()
Returns
Type Description
FindNeighborsResponse.Neighbor

getDistance()

public double getDistance()

The distance between the neighbor and the dense embedding query.

double distance = 2;

Returns
Type Description
double

The distance.

getParserForType()

public Parser<FindNeighborsResponse.Neighbor> getParserForType()
Returns
Type Description
Parser<Neighbor>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSparseDistance()

public double getSparseDistance()

The distance between the neighbor and the query sparse_embedding.

double sparse_distance = 3;

Returns
Type Description
double

The sparseDistance.

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.v1beta1.IndexDatapoint datapoint = 1;

Returns
Type Description
boolean

Whether the datapoint field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FindNeighborsResponse.Neighbor.Builder newBuilderForType()
Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FindNeighborsResponse.Neighbor.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FindNeighborsResponse.Neighbor.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FindNeighborsResponse.Neighbor.Builder toBuilder()
Returns
Type Description
FindNeighborsResponse.Neighbor.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException