Send feedback
Class FindNeighborsRequest (3.13.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.13.0 keyboard_arrow_down
public final class FindNeighborsRequest extends GeneratedMessageV3 implements FindNeighborsRequestOrBuilder
The request message for
MatchService.FindNeighbors .
Protobuf type google.cloud.aiplatform.v1beta1.FindNeighborsRequest
Static Fields
public static final int DEPLOYED_INDEX_ID_FIELD_NUMBER
Field Value
public static final int INDEX_ENDPOINT_FIELD_NUMBER
Field Value
public static final int QUERIES_FIELD_NUMBER
Field Value
public static final int RETURN_FULL_DATAPOINT_FIELD_NUMBER
Field Value
Static Methods
public static FindNeighborsRequest getDefaultInstance ()
Returns
public static final Descriptors . Descriptor getDescriptor ()
Returns
public static FindNeighborsRequest . Builder newBuilder ()
Returns
public static FindNeighborsRequest . Builder newBuilder ( FindNeighborsRequest prototype )
Parameter
Returns
public static FindNeighborsRequest parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static FindNeighborsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static FindNeighborsRequest parseFrom ( byte [] data )
Parameter
Name Description databyte []
Returns
Exceptions
public static FindNeighborsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static FindNeighborsRequest parseFrom ( ByteString data )
Parameter
Returns
Exceptions
public static FindNeighborsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static FindNeighborsRequest parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static FindNeighborsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static FindNeighborsRequest parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static FindNeighborsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static FindNeighborsRequest parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
public static FindNeighborsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Parser<FindNeighborsRequest> parser ()
Returns
Methods
public boolean equals ( Object obj )
Parameter
Returns
Overrides
public FindNeighborsRequest getDefaultInstanceForType ()
Returns
public String getDeployedIndexId ()
The ID of the DeploydIndex 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 DeploydIndex 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 ()
Returns
Overrides
public FindNeighborsRequest . Query getQueries ( int index )
The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
Parameter
Returns
public int getQueriesCount ()
The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
Returns
public List<FindNeighborsRequest . Query > getQueriesList ()
The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
Returns
public FindNeighborsRequest . QueryOrBuilder getQueriesOrBuilder ( int index )
The list of queries.
repeated .google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query queries = 3;
Parameter
Returns
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
Overrides
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
public final boolean isInitialized ()
Returns
Overrides
public FindNeighborsRequest . Builder newBuilderForType ()
Returns
protected FindNeighborsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
public FindNeighborsRequest . Builder toBuilder ()
Returns
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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-01-28 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-01-28 UTC."],[],[]]
