Class NearestNeighbors.Neighbor (3.44.0)

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

A neighbor of the query vector.

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

Static Fields

DISTANCE_FIELD_NUMBER

public static final int DISTANCE_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_ID_FIELD_NUMBER

public static final int ENTITY_ID_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_KEY_VALUES_FIELD_NUMBER

public static final int ENTITY_KEY_VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(NearestNeighbors.Neighbor prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<NearestNeighbors.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

getDefaultInstanceForType()

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

getDistance()

public double getDistance()

The distance between the neighbor and the query vector.

double distance = 2;

Returns
Type Description
double

The distance.

getEntityId()

public String getEntityId()

The id of the similar entity.

string entity_id = 1;

Returns
Type Description
String

The entityId.

getEntityIdBytes()

public ByteString getEntityIdBytes()

The id of the similar entity.

string entity_id = 1;

Returns
Type Description
ByteString

The bytes for entityId.

getEntityKeyValues()

public FetchFeatureValuesResponse getEntityKeyValues()

The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true. Otherwise, only the "entity_id" and "distance" fields are populated.

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

Returns
Type Description
FetchFeatureValuesResponse

The entityKeyValues.

getEntityKeyValuesOrBuilder()

public FetchFeatureValuesResponseOrBuilder getEntityKeyValuesOrBuilder()

The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true. Otherwise, only the "entity_id" and "distance" fields are populated.

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

Returns
Type Description
FetchFeatureValuesResponseOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasEntityKeyValues()

public boolean hasEntityKeyValues()

The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true. Otherwise, only the "entity_id" and "distance" fields are populated.

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

Returns
Type Description
boolean

Whether the entityKeyValues 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 NearestNeighbors.Neighbor.Builder newBuilderForType()
Returns
Type Description
NearestNeighbors.Neighbor.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NearestNeighbors.Neighbor.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
NearestNeighbors.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 NearestNeighbors.Neighbor.Builder toBuilder()
Returns
Type Description
NearestNeighbors.Neighbor.Builder

writeTo(CodedOutputStream output)

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