Package com.google.cloud.aiplatform.v1

Class FindNeighborsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.FindNeighborsRequest
All Implemented Interfaces:
FindNeighborsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class FindNeighborsRequest extends com.google.protobuf.GeneratedMessage implements FindNeighborsRequestOrBuilder
 The request message for
 [MatchService.FindNeighbors][google.cloud.aiplatform.v1.MatchService.FindNeighbors].
Protobuf type google.cloud.aiplatform.v1.FindNeighborsRequest
See Also:

  • Field Details

    • INDEX_ENDPOINT_FIELD_NUMBER

      public static final int INDEX_ENDPOINT_FIELD_NUMBER
      See Also:

    • DEPLOYED_INDEX_ID_FIELD_NUMBER

      public static final int DEPLOYED_INDEX_ID_FIELD_NUMBER
      See Also:

    • QUERIES_FIELD_NUMBER

      public static final int QUERIES_FIELD_NUMBER
      See Also:

    • RETURN_FULL_DATAPOINT_FIELD_NUMBER

      public static final int RETURN_FULL_DATAPOINT_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

    • getIndexEndpoint

      public String getIndexEndpoint()
       Required. The name of the index endpoint.
 Format:
 `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
      string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getIndexEndpoint in interface FindNeighborsRequestOrBuilder
      Returns:
      The indexEndpoint.

    • getIndexEndpointBytes

      public com.google.protobuf.ByteString getIndexEndpointBytes()
       Required. The name of the index endpoint.
 Format:
 `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
      string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getIndexEndpointBytes in interface FindNeighborsRequestOrBuilder
      Returns:
      The bytes for indexEndpoint.

    • getDeployedIndexId

      public String getDeployedIndexId()
       The ID of the DeployedIndex that will serve the request. This request is
 sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
 IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
 has a DeployedIndex.id field.
 The value of the field below must equal one of the DeployedIndex.id
 fields of the IndexEndpoint that is being called for this request.
      string deployed_index_id = 2;
      Specified by:
      getDeployedIndexId in interface FindNeighborsRequestOrBuilder
      Returns:
      The deployedIndexId.

    • getDeployedIndexIdBytes

      public com.google.protobuf.ByteString getDeployedIndexIdBytes()
       The ID of the DeployedIndex that will serve the request. This request is
 sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
 IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
 has a DeployedIndex.id field.
 The value of the field below must equal one of the DeployedIndex.id
 fields of the IndexEndpoint that is being called for this request.
      string deployed_index_id = 2;
      Specified by:
      getDeployedIndexIdBytes in interface FindNeighborsRequestOrBuilder
      Returns:
      The bytes for deployedIndexId.

    • getQueriesList

      public List<FindNeighborsRequest.Query> getQueriesList()
       The list of queries.
      repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;
      Specified by:
      getQueriesList in interface FindNeighborsRequestOrBuilder

    • getQueriesOrBuilderList

      public List<? extends FindNeighborsRequest.QueryOrBuilder> getQueriesOrBuilderList()
       The list of queries.
      repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;
      Specified by:
      getQueriesOrBuilderList in interface FindNeighborsRequestOrBuilder

    • getQueriesCount

      public int getQueriesCount()
       The list of queries.
      repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;
      Specified by:
      getQueriesCount in interface FindNeighborsRequestOrBuilder

    • getQueries

      public FindNeighborsRequest.Query getQueries(int index)
       The list of queries.
      repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;
      Specified by:
      getQueries in interface FindNeighborsRequestOrBuilder

    • getQueriesOrBuilder

      public FindNeighborsRequest.QueryOrBuilder getQueriesOrBuilder(int index)
       The list of queries.
      repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;
      Specified by:
      getQueriesOrBuilder in interface FindNeighborsRequestOrBuilder

    • getReturnFullDatapoint

      public boolean getReturnFullDatapoint()
       If set to true, the full datapoints (including all vector values and
 restricts) of the nearest neighbors are returned.
 Note that returning full datapoint will significantly increase the
 latency and cost of the query.
      bool return_full_datapoint = 4;
      Specified by:
      getReturnFullDatapoint in interface FindNeighborsRequestOrBuilder
      Returns:
      The returnFullDatapoint.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static FindNeighborsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FindNeighborsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static FindNeighborsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static FindNeighborsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FindNeighborsRequest.Builder newBuilder()

    • newBuilder

      public static FindNeighborsRequest.Builder newBuilder(FindNeighborsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FindNeighborsRequest getDefaultInstance()

    • parser

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

    • getParserForType

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