Package com.google.cloud.aiplatform.v1

Class NearestNeighbors.Neighbor

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.NearestNeighbors.Neighbor
All Implemented Interfaces:
NearestNeighbors.NeighborOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
NearestNeighbors
public static final class NearestNeighbors.Neighbor extends com.google.protobuf.GeneratedMessage implements NearestNeighbors.NeighborOrBuilder
 A neighbor of the query vector.
Protobuf type google.cloud.aiplatform.v1.NearestNeighbors.Neighbor
See Also:

  • Field Details

    • ENTITY_ID_FIELD_NUMBER

      public static final int ENTITY_ID_FIELD_NUMBER
      See Also:

    • DISTANCE_FIELD_NUMBER

      public static final int DISTANCE_FIELD_NUMBER
      See Also:

    • ENTITY_KEY_VALUES_FIELD_NUMBER

      public static final int ENTITY_KEY_VALUES_FIELD_NUMBER
      See Also:

  • 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

    • getEntityId

      public String getEntityId()
       The id of the similar entity.
      string entity_id = 1;
      Specified by:
      getEntityId in interface NearestNeighbors.NeighborOrBuilder
      Returns:
      The entityId.

    • getEntityIdBytes

      public com.google.protobuf.ByteString getEntityIdBytes()
       The id of the similar entity.
      string entity_id = 1;
      Specified by:
      getEntityIdBytes in interface NearestNeighbors.NeighborOrBuilder
      Returns:
      The bytes for entityId.

    • getDistance

      public double getDistance()
       The distance between the neighbor and the query vector.
      double distance = 2;
      Specified by:
      getDistance in interface NearestNeighbors.NeighborOrBuilder
      Returns:
      The distance.

    • 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;
      Specified by:
      hasEntityKeyValues in interface NearestNeighbors.NeighborOrBuilder
      Returns:
      Whether the entityKeyValues field is set.

    • 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;
      Specified by:
      getEntityKeyValues in interface NearestNeighbors.NeighborOrBuilder
      Returns:
      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;
      Specified by:
      getEntityKeyValuesOrBuilder in interface NearestNeighbors.NeighborOrBuilder

    • 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 NearestNeighbors.Neighbor parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static NearestNeighbors.Neighbor parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NearestNeighbors.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 NearestNeighbors.Neighbor parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static NearestNeighbors.Neighbor parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static NearestNeighbors.Neighbor parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static NearestNeighbors.Neighbor parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public NearestNeighbors.Neighbor.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static NearestNeighbors.Neighbor.Builder newBuilder()

    • newBuilder

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

    • toBuilder

      public NearestNeighbors.Neighbor.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected NearestNeighbors.Neighbor.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static NearestNeighbors.Neighbor getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<NearestNeighbors.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 NearestNeighbors.Neighbor getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder