Class FindNeighborsRequest.Builder (3.29.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
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1.FindNeighborsRequest.Query>
Returns
TypeDescription
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
NameDescription
valueFindNeighborsRequest.Query
Returns
TypeDescription
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
NameDescription
builderForValueFindNeighborsRequest.Query.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueFindNeighborsRequest.Query
Returns
TypeDescription
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
NameDescription
indexint
builderForValueFindNeighborsRequest.Query.Builder
Returns
TypeDescription
FindNeighborsRequest.Builder

addQueriesBuilder()

public FindNeighborsRequest.Query.Builder addQueriesBuilder()

The list of queries.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
FindNeighborsRequest.Query.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FindNeighborsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
FindNeighborsRequest.Builder
Overrides

build()

public FindNeighborsRequest build()
Returns
TypeDescription
FindNeighborsRequest

buildPartial()

public FindNeighborsRequest buildPartial()
Returns
TypeDescription
FindNeighborsRequest

clear()

public FindNeighborsRequest.Builder clear()
Returns
TypeDescription
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
TypeDescription
FindNeighborsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FindNeighborsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
FindNeighborsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FindNeighborsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
FindNeighborsRequest.Builder
Overrides

clearQueries()

public FindNeighborsRequest.Builder clearQueries()

The list of queries.

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

Returns
TypeDescription
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
TypeDescription
FindNeighborsRequest.Builder

This builder for chaining.

clone()

public FindNeighborsRequest.Builder clone()
Returns
TypeDescription
FindNeighborsRequest.Builder
Overrides

getDefaultInstanceForType()

public FindNeighborsRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for deployedIndexId.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
FindNeighborsRequest.Query.Builder

getQueriesBuilderList()

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

The list of queries.

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

Returns
TypeDescription
List<Builder>

getQueriesCount()

public int getQueriesCount()

The list of queries.

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

Returns
TypeDescription
int

getQueriesList()

public List<FindNeighborsRequest.Query> getQueriesList()

The list of queries.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
FindNeighborsRequest.QueryOrBuilder

getQueriesOrBuilderList()

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

The list of queries.

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

Returns
TypeDescription
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
TypeDescription
boolean

The returnFullDatapoint.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(FindNeighborsRequest other)

public FindNeighborsRequest.Builder mergeFrom(FindNeighborsRequest other)
Parameter
NameDescription
otherFindNeighborsRequest
Returns
TypeDescription
FindNeighborsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FindNeighborsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FindNeighborsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public FindNeighborsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
FindNeighborsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FindNeighborsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueString

The deployedIndexId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for deployedIndexId to set.

Returns
TypeDescription
FindNeighborsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FindNeighborsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The indexEndpoint to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for indexEndpoint to set.

Returns
TypeDescription
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
NameDescription
indexint
valueFindNeighborsRequest.Query
Returns
TypeDescription
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
NameDescription
indexint
builderForValueFindNeighborsRequest.Query.Builder
Returns
TypeDescription
FindNeighborsRequest.Builder

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

public FindNeighborsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueboolean

The returnFullDatapoint to set.

Returns
TypeDescription
FindNeighborsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final FindNeighborsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
FindNeighborsRequest.Builder
Overrides