Class FindNeighborsRequest.Builder (3.17.0)

Version 3.17.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static final class FindNeighborsRequest.Builder extends GeneratedMessageV3.Builder<FindNeighborsRequest.Builder> implements FindNeighborsRequestOrBuilder

The request message for MatchService.FindNeighbors.

Protobuf type google.cloud.aiplatform.v1beta1.FindNeighborsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FindNeighborsRequest.Builder

Implements

FindNeighborsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllQueries(Iterable<? extends FindNeighborsRequest.Query> values)

public FindNeighborsRequest.Builder addAllQueries(Iterable<? extends FindNeighborsRequest.Query> values)

The list of queries.

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

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query>

Returns
Type	Description
FindNeighborsRequest.Builder

addQueries(FindNeighborsRequest.Query value)

public FindNeighborsRequest.Builder addQueries(FindNeighborsRequest.Query value)

The list of queries.

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

Parameter
Name	Description
value	FindNeighborsRequest.Query

Returns
Type	Description
FindNeighborsRequest.Builder

addQueries(FindNeighborsRequest.Query.Builder builderForValue)

public FindNeighborsRequest.Builder addQueries(FindNeighborsRequest.Query.Builder builderForValue)

The list of queries.

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

Parameter
Name	Description
builderForValue	FindNeighborsRequest.Query.Builder

Returns
Type	Description
FindNeighborsRequest.Builder

addQueries(int index, FindNeighborsRequest.Query value)

public FindNeighborsRequest.Builder addQueries(int index, FindNeighborsRequest.Query value)

The list of queries.

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

Parameters
Name	Description
index	int
value	FindNeighborsRequest.Query

Returns
Type	Description
FindNeighborsRequest.Builder

addQueries(int index, FindNeighborsRequest.Query.Builder builderForValue)

public FindNeighborsRequest.Builder addQueries(int index, FindNeighborsRequest.Query.Builder builderForValue)

The list of queries.

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

Parameters
Name	Description
index	int
builderForValue	FindNeighborsRequest.Query.Builder

Returns
Type	Description
FindNeighborsRequest.Builder

addQueriesBuilder()

public FindNeighborsRequest.Query.Builder addQueriesBuilder()

The list of queries.

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

Returns
Type	Description
FindNeighborsRequest.Query.Builder

addQueriesBuilder(int index)

public FindNeighborsRequest.Query.Builder addQueriesBuilder(int index)

The list of queries.

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

Parameter
Name	Description
index	int

Returns
Type	Description
FindNeighborsRequest.Query.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FindNeighborsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
FindNeighborsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public FindNeighborsRequest build()

Returns
Type	Description
FindNeighborsRequest

buildPartial()

public FindNeighborsRequest buildPartial()

Returns
Type	Description
FindNeighborsRequest

clear()

public FindNeighborsRequest.Builder clear()

Returns
Type	Description
FindNeighborsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDeployedIndexId()

public FindNeighborsRequest.Builder clearDeployedIndexId()

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
FindNeighborsRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FindNeighborsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
FindNeighborsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIndexEndpoint()

public FindNeighborsRequest.Builder clearIndexEndpoint()

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
FindNeighborsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FindNeighborsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
FindNeighborsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearQueries()

public FindNeighborsRequest.Builder clearQueries()

The list of queries.

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

Returns
Type	Description
FindNeighborsRequest.Builder

clearReturnFullDatapoint()

public FindNeighborsRequest.Builder clearReturnFullDatapoint()

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
FindNeighborsRequest.Builder	This builder for chaining.

clone()

public FindNeighborsRequest.Builder clone()

Returns
Type	Description
FindNeighborsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public FindNeighborsRequest getDefaultInstanceForType()

Returns
Type	Description
FindNeighborsRequest

getDeployedIndexId()

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.

getDeployedIndexIdBytes()

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getQueries(int index)

public FindNeighborsRequest.Query getQueries(int index)

The list of queries.

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

Parameter
Name	Description
index	int

Returns
Type	Description
FindNeighborsRequest.Query

getQueriesBuilder(int index)

public FindNeighborsRequest.Query.Builder getQueriesBuilder(int index)

The list of queries.

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

Parameter
Name	Description
index	int

Returns
Type	Description
FindNeighborsRequest.Query.Builder

getQueriesBuilderList()

public List<FindNeighborsRequest.Query.Builder> getQueriesBuilderList()

The list of queries.

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

Returns
Type	Description
List<Builder>

getQueriesCount()

public int getQueriesCount()

The list of queries.

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

Returns
Type	Description
int

getQueriesList()

public List<FindNeighborsRequest.Query> getQueriesList()

The list of queries.

repeated .google.cloud.aiplatform.v1beta1.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.v1beta1.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.v1beta1.FindNeighborsRequest.Query queries = 3;

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1beta1.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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(FindNeighborsRequest other)

public FindNeighborsRequest.Builder mergeFrom(FindNeighborsRequest other)

Parameter
Name	Description
other	FindNeighborsRequest

Returns
Type	Description
FindNeighborsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FindNeighborsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FindNeighborsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public FindNeighborsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
FindNeighborsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FindNeighborsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
FindNeighborsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeQueries(int index)

public FindNeighborsRequest.Builder removeQueries(int index)

The list of queries.

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

Parameter
Name	Description
index	int

Returns
Type	Description
FindNeighborsRequest.Builder

setDeployedIndexId(String value)

public FindNeighborsRequest.Builder setDeployedIndexId(String value)

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;

Parameter
Name	Description
value	String The deployedIndexId to set.

Returns
Type	Description
FindNeighborsRequest.Builder	This builder for chaining.

setDeployedIndexIdBytes(ByteString value)

public FindNeighborsRequest.Builder setDeployedIndexIdBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for deployedIndexId to set.

Returns
Type	Description
FindNeighborsRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FindNeighborsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
FindNeighborsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIndexEndpoint(String value)

public FindNeighborsRequest.Builder setIndexEndpoint(String value)

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

Parameter
Name	Description
value	String The indexEndpoint to set.

Returns
Type	Description
FindNeighborsRequest.Builder	This builder for chaining.

setIndexEndpointBytes(ByteString value)

public FindNeighborsRequest.Builder setIndexEndpointBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for indexEndpoint to set.

Returns
Type	Description
FindNeighborsRequest.Builder	This builder for chaining.

setQueries(int index, FindNeighborsRequest.Query value)

public FindNeighborsRequest.Builder setQueries(int index, FindNeighborsRequest.Query value)

The list of queries.

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

Parameters
Name	Description
index	int
value	FindNeighborsRequest.Query

Returns
Type	Description
FindNeighborsRequest.Builder

setQueries(int index, FindNeighborsRequest.Query.Builder builderForValue)

public FindNeighborsRequest.Builder setQueries(int index, FindNeighborsRequest.Query.Builder builderForValue)

The list of queries.

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

Parameters
Name	Description
index	int
builderForValue	FindNeighborsRequest.Query.Builder

Returns
Type	Description
FindNeighborsRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FindNeighborsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
FindNeighborsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setReturnFullDatapoint(boolean value)

public FindNeighborsRequest.Builder setReturnFullDatapoint(boolean value)

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;

Parameter
Name	Description
value	boolean The returnFullDatapoint to set.

Returns
Type	Description
FindNeighborsRequest.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final FindNeighborsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
FindNeighborsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)