Class FindNeighborsRequest (3.77.0)
Version 3.77.0keyboard_arrow_down
public final class FindNeighborsRequest extends GeneratedMessageV3 implements FindNeighborsRequestOrBuilder
The request message for
MatchService.FindNeighbors .
Protobuf type google.cloud.aiplatform.v1beta1.FindNeighborsRequest
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 DEPLOYED_INDEX_ID_FIELD_NUMBER
Field Value
Type Description
int
public static final int INDEX_ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int
public static final int QUERIES_FIELD_NUMBER
Field Value
Type Description
int
public static final int RETURN_FULL_DATAPOINT_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static FindNeighborsRequest getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static FindNeighborsRequest . Builder newBuilder ()
public static FindNeighborsRequest . Builder newBuilder ( FindNeighborsRequest prototype )
public static FindNeighborsRequest parseDelimitedFrom ( InputStream input )
public static FindNeighborsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static FindNeighborsRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static FindNeighborsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static FindNeighborsRequest parseFrom ( ByteString data )
public static FindNeighborsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static FindNeighborsRequest parseFrom ( CodedInputStream input )
public static FindNeighborsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static FindNeighborsRequest parseFrom ( InputStream input )
public static FindNeighborsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static FindNeighborsRequest parseFrom ( ByteBuffer data )
public static FindNeighborsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<FindNeighborsRequest> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public FindNeighborsRequest getDefaultInstanceForType ()
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;
Returns
Type Description
String The deployedIndexId.
public 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;
Returns
Type Description
ByteString The bytes for deployedIndexId.
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) = { ... }
Returns
Type Description
String The indexEndpoint.
public 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) = { ... }
Returns
Type Description
ByteString The bytes for indexEndpoint.
public Parser<FindNeighborsRequest> getParserForType ()
Overrides
public FindNeighborsRequest . Query getQueries ( int index )
The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
Parameter
Name Description
indexint
public int getQueriesCount ()
The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
Returns
Type Description
int
public List<FindNeighborsRequest . Query > getQueriesList ()
The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
public FindNeighborsRequest . QueryOrBuilder getQueriesOrBuilder ( int index )
The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
Parameter
Name Description
indexint
public List <? extends FindNeighborsRequest . QueryOrBuilder > getQueriesOrBuilderList ()
The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
Returns
Type Description
List <? extends com.google.cloud.aiplatform.v1beta1.FindNeighborsRequest.QueryOrBuilder >
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;
Returns
Type Description
boolean The returnFullDatapoint.
public int getSerializedSize ()
Returns
Type Description
int
Overrides
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public FindNeighborsRequest . Builder newBuilderForType ()
protected FindNeighborsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public FindNeighborsRequest . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
