Send feedback
  
   
 
  
    
      Class NearestNeighbors.Neighbor (3.79.0) 
  
  
  
   
  
    
  
  
    
    
    
    
    
  Version latestkeyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   static   final   class  NearestNeighbors . Neighbor   extends   GeneratedMessageV3   implements   NearestNeighbors . NeighborOrBuilder  
   A neighbor of the query vector.
 Protobuf type google.cloud.aiplatform.v1beta1.NearestNeighbors.Neighbor
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  
  
    
public   static   final   int   DISTANCE_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   ENTITY_ID_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   ENTITY_KEY_VALUES_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  
    
public   static   NearestNeighbors . Neighbor   getDefaultInstance ()  
  
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  
    
public   static   NearestNeighbors . Neighbor . Builder   newBuilder ()  
  
  
    
public   static   NearestNeighbors . Neighbor . Builder   newBuilder ( NearestNeighbors . Neighbor   prototype )  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseFrom ( ByteString   data )  
  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseFrom ( ByteBuffer   data )  
  
  
  
  
    
public   static   NearestNeighbors . Neighbor   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   Parser<NearestNeighbors . Neighbor >  parser ()  
  
  Methods
   
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  
    
public   NearestNeighbors . Neighbor   getDefaultInstanceForType ()  
  
  
    
public   double   getDistance ()  
   The distance between the neighbor and the query vector.
 double distance = 2;
    
      
        Returns  
      
        Type Description  
      
        double The distance.
 
     
  
  
    
public   String   getEntityId ()  
   The id of the similar entity.
 string entity_id = 1;
    
      
        Returns  
      
        Type Description  
      
        String The entityId.
 
     
  
  
    
public   ByteString   getEntityIdBytes ()  
   The id of the similar entity.
 string entity_id = 1;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for entityId.
 
     
  
  
    
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.v1beta1.FetchFeatureValuesResponse entity_key_values = 3;
 
    
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.v1beta1.FetchFeatureValuesResponse entity_key_values = 3;
 
    
public   Parser<NearestNeighbors . Neighbor >  getParserForType ()  
  
  Overrides 
  
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  
    
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.v1beta1.FetchFeatureValuesResponse entity_key_values = 3;
 
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the entityKeyValues field is set.
 
     
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  
    
public   NearestNeighbors . Neighbor . Builder   newBuilderForType ()  
  
  
    
protected   NearestNeighbors . Neighbor . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  
    
public   NearestNeighbors . Neighbor . Builder   toBuilder ()  
  
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-29 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]