Class FindNeighborsRequest.Builder (3.42.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.v1.FindNeighborsRequest

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.v1.FindNeighborsRequest.Query queries = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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

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

clearDeployedIndexId()

public FindNeighborsRequest.Builder clearDeployedIndexId()

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

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

clearQueries()

public FindNeighborsRequest.Builder clearQueries()

The list of queries.

repeated .google.cloud.aiplatform.v1.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

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.v1.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.v1.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.v1.FindNeighborsRequest.Query queries = 3;

Returns
Type Description
List<Builder>

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FindNeighborsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FindNeighborsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FindNeighborsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FindNeighborsRequest.Builder
Overrides

removeQueries(int index)

public FindNeighborsRequest.Builder removeQueries(int index)

The list of queries.

repeated .google.cloud.aiplatform.v1.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 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;

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 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;

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

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

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