Class FindNeighborsRequest (3.43.0)

public final class FindNeighborsRequest extends GeneratedMessageV3 implements FindNeighborsRequestOrBuilder

The request message for MatchService.FindNeighbors.

Protobuf type google.cloud.aiplatform.v1.FindNeighborsRequest

Static Fields

DEPLOYED_INDEX_ID_FIELD_NUMBER

public static final int DEPLOYED_INDEX_ID_FIELD_NUMBER
Field Value
Type Description
int

INDEX_ENDPOINT_FIELD_NUMBER

public static final int INDEX_ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

QUERIES_FIELD_NUMBER

public static final int QUERIES_FIELD_NUMBER
Field Value
Type Description
int

RETURN_FULL_DATAPOINT_FIELD_NUMBER

public static final int RETURN_FULL_DATAPOINT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FindNeighborsRequest getDefaultInstance()
Returns
Type Description
FindNeighborsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FindNeighborsRequest.Builder newBuilder()
Returns
Type Description
FindNeighborsRequest.Builder

newBuilder(FindNeighborsRequest prototype)

public static FindNeighborsRequest.Builder newBuilder(FindNeighborsRequest prototype)
Parameter
Name Description
prototype FindNeighborsRequest
Returns
Type Description
FindNeighborsRequest.Builder

parseDelimitedFrom(InputStream input)

public static FindNeighborsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FindNeighborsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FindNeighborsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FindNeighborsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FindNeighborsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FindNeighborsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FindNeighborsRequest> parser()
Returns
Type Description
Parser<FindNeighborsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public FindNeighborsRequest getDefaultInstanceForType()
Returns
Type Description
FindNeighborsRequest

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;

Returns
Type Description
String

The deployedIndexId.

getDeployedIndexIdBytes()

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.

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) = { ... }

Returns
Type Description
String

The indexEndpoint.

getIndexEndpointBytes()

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.

getParserForType()

public Parser<FindNeighborsRequest> getParserForType()
Returns
Type Description
Parser<FindNeighborsRequest>
Overrides

getQueries(int index)

public FindNeighborsRequest.Query getQueries(int index)

The list of queries.

repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

Parameter
Name Description
index int
Returns
Type Description
FindNeighborsRequest.Query

getQueriesCount()

public int getQueriesCount()

The list of queries.

repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

Returns
Type Description
int

getQueriesList()

public List<FindNeighborsRequest.Query> getQueriesList()

The list of queries.

repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

Returns
Type Description
List<Query>

getQueriesOrBuilder(int index)

public FindNeighborsRequest.QueryOrBuilder getQueriesOrBuilder(int index)

The list of queries.

repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

Parameter
Name Description
index int
Returns
Type Description
FindNeighborsRequest.QueryOrBuilder

getQueriesOrBuilderList()

public List<? extends FindNeighborsRequest.QueryOrBuilder> getQueriesOrBuilderList()

The list of queries.

repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.FindNeighborsRequest.QueryOrBuilder>

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;

Returns
Type Description
boolean

The returnFullDatapoint.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FindNeighborsRequest.Builder newBuilderForType()
Returns
Type Description
FindNeighborsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FindNeighborsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FindNeighborsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FindNeighborsRequest.Builder toBuilder()
Returns
Type Description
FindNeighborsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException