com.google.cloud.aiplatform.v1

Class FindNeighborsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

public final class FindNeighborsRequest
extends com.google.protobuf.GeneratedMessageV3
implements FindNeighborsRequestOrBuilder

 The request message for
 [MatchService.FindNeighbors][google.cloud.aiplatform.v1.MatchService.FindNeighbors].
 

Protobuf type google.cloud.aiplatform.v1.FindNeighborsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FindNeighborsRequest.Builder The request message for [MatchService.FindNeighbors][google.cloud.aiplatform.v1.MatchService.FindNeighbors].
static class	FindNeighborsRequest.Query A query to find a number of the nearest neighbors (most similar vectors) of a vector.
static interface	FindNeighborsRequest.QueryOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEPLOYED_INDEX_ID_FIELD_NUMBER
static int	INDEX_ENDPOINT_FIELD_NUMBER
static int	QUERIES_FIELD_NUMBER
static int	RETURN_FULL_DATAPOINT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static FindNeighborsRequest	getDefaultInstance()
FindNeighborsRequest	getDefaultInstanceForType()
String	getDeployedIndexId() The ID of the DeployedIndex that will serve the request.
com.google.protobuf.ByteString	getDeployedIndexIdBytes() The ID of the DeployedIndex that will serve the request.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getIndexEndpoint() Required.
com.google.protobuf.ByteString	getIndexEndpointBytes() Required.
com.google.protobuf.Parser<FindNeighborsRequest>	getParserForType()
FindNeighborsRequest.Query	getQueries(int index) The list of queries.
int	getQueriesCount() The list of queries.
List<FindNeighborsRequest.Query>	getQueriesList() The list of queries.
FindNeighborsRequest.QueryOrBuilder	getQueriesOrBuilder(int index) The list of queries.
List<? extends FindNeighborsRequest.QueryOrBuilder>	getQueriesOrBuilderList() The list of queries.
boolean	getReturnFullDatapoint() If set to true, the full datapoints (including all vector values and restricts) of the nearest neighbors are returned.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FindNeighborsRequest.Builder	newBuilder()
static FindNeighborsRequest.Builder	newBuilder(FindNeighborsRequest prototype)
FindNeighborsRequest.Builder	newBuilderForType()
protected FindNeighborsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FindNeighborsRequest	parseDelimitedFrom(InputStream input)
static FindNeighborsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsRequest	parseFrom(byte[] data)
static FindNeighborsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsRequest	parseFrom(ByteBuffer data)
static FindNeighborsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsRequest	parseFrom(com.google.protobuf.ByteString data)
static FindNeighborsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static FindNeighborsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsRequest	parseFrom(InputStream input)
static FindNeighborsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FindNeighborsRequest>	parser()
FindNeighborsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INDEX_ENDPOINT_FIELD_NUMBER

public static final int INDEX_ENDPOINT_FIELD_NUMBER

See Also:

Constant Field Values

DEPLOYED_INDEX_ID_FIELD_NUMBER

public static final int DEPLOYED_INDEX_ID_FIELD_NUMBER

See Also:

Constant Field Values

QUERIES_FIELD_NUMBER

public static final int QUERIES_FIELD_NUMBER

See Also:

Constant Field Values

RETURN_FULL_DATAPOINT_FIELD_NUMBER

public static final int RETURN_FULL_DATAPOINT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

getDefaultInstanceForType

public FindNeighborsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder