Class NearestNeighborQuery.Builder (3.52.0)

Version latest

• 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 NearestNeighborQuery.Builder extends GeneratedMessageV3.Builder<NearestNeighborQuery.Builder> implements NearestNeighborQueryOrBuilder

A query to find a number of similar entities.

Protobuf type google.cloud.aiplatform.v1.NearestNeighborQuery

Inheritance

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

Implements

NearestNeighborQueryOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(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

addAllNumericFilters(Iterable<? extends NearestNeighborQuery.NumericFilter> values)

public NearestNeighborQuery.Builder addAllNumericFilters(Iterable<? extends NearestNeighborQuery.NumericFilter> values)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter>

Returns
Type	Description
NearestNeighborQuery.Builder

addAllStringFilters(Iterable<? extends NearestNeighborQuery.StringFilter> values)

public NearestNeighborQuery.Builder addAllStringFilters(Iterable<? extends NearestNeighborQuery.StringFilter> values)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter>

Returns
Type	Description
NearestNeighborQuery.Builder

addNumericFilters(NearestNeighborQuery.NumericFilter value)

public NearestNeighborQuery.Builder addNumericFilters(NearestNeighborQuery.NumericFilter value)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	NearestNeighborQuery.NumericFilter

Returns
Type	Description
NearestNeighborQuery.Builder

addNumericFilters(NearestNeighborQuery.NumericFilter.Builder builderForValue)

public NearestNeighborQuery.Builder addNumericFilters(NearestNeighborQuery.NumericFilter.Builder builderForValue)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	NearestNeighborQuery.NumericFilter.Builder

Returns
Type	Description
NearestNeighborQuery.Builder

addNumericFilters(int index, NearestNeighborQuery.NumericFilter value)

public NearestNeighborQuery.Builder addNumericFilters(int index, NearestNeighborQuery.NumericFilter value)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	NearestNeighborQuery.NumericFilter

Returns
Type	Description
NearestNeighborQuery.Builder

addNumericFilters(int index, NearestNeighborQuery.NumericFilter.Builder builderForValue)

public NearestNeighborQuery.Builder addNumericFilters(int index, NearestNeighborQuery.NumericFilter.Builder builderForValue)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	NearestNeighborQuery.NumericFilter.Builder

Returns
Type	Description
NearestNeighborQuery.Builder

addNumericFiltersBuilder()

public NearestNeighborQuery.NumericFilter.Builder addNumericFiltersBuilder()

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.NumericFilter.Builder

addNumericFiltersBuilder(int index)

public NearestNeighborQuery.NumericFilter.Builder addNumericFiltersBuilder(int index)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NearestNeighborQuery.NumericFilter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
NearestNeighborQuery.Builder

Overrides

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

addStringFilters(NearestNeighborQuery.StringFilter value)

public NearestNeighborQuery.Builder addStringFilters(NearestNeighborQuery.StringFilter value)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	NearestNeighborQuery.StringFilter

Returns
Type	Description
NearestNeighborQuery.Builder

addStringFilters(NearestNeighborQuery.StringFilter.Builder builderForValue)

public NearestNeighborQuery.Builder addStringFilters(NearestNeighborQuery.StringFilter.Builder builderForValue)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	NearestNeighborQuery.StringFilter.Builder

Returns
Type	Description
NearestNeighborQuery.Builder

addStringFilters(int index, NearestNeighborQuery.StringFilter value)

public NearestNeighborQuery.Builder addStringFilters(int index, NearestNeighborQuery.StringFilter value)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	NearestNeighborQuery.StringFilter

Returns
Type	Description
NearestNeighborQuery.Builder

addStringFilters(int index, NearestNeighborQuery.StringFilter.Builder builderForValue)

public NearestNeighborQuery.Builder addStringFilters(int index, NearestNeighborQuery.StringFilter.Builder builderForValue)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	NearestNeighborQuery.StringFilter.Builder

Returns
Type	Description
NearestNeighborQuery.Builder

addStringFiltersBuilder()

public NearestNeighborQuery.StringFilter.Builder addStringFiltersBuilder()

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

addStringFiltersBuilder(int index)

public NearestNeighborQuery.StringFilter.Builder addStringFiltersBuilder(int index)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

build()

public NearestNeighborQuery build()

Returns
Type	Description
NearestNeighborQuery

buildPartial()

public NearestNeighborQuery buildPartial()

Returns
Type	Description
NearestNeighborQuery

clear()

public NearestNeighborQuery.Builder clear()

Returns
Type	Description
NearestNeighborQuery.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearEmbedding()

public NearestNeighborQuery.Builder clearEmbedding()

Optional. The embedding vector that be used for similar search.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.Builder

clearEntityId()

public NearestNeighborQuery.Builder clearEntityId()

Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.

string entity_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public NearestNeighborQuery.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
NearestNeighborQuery.Builder

Overrides

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

clearInstance()

public NearestNeighborQuery.Builder clearInstance()

Returns
Type	Description
NearestNeighborQuery.Builder

clearNeighborCount()

public NearestNeighborQuery.Builder clearNeighborCount()

Optional. The number of similar entities to be retrieved from feature view for each query.

int32 neighbor_count = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.Builder	This builder for chaining.

clearNumericFilters()

public NearestNeighborQuery.Builder clearNumericFilters()

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public NearestNeighborQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
NearestNeighborQuery.Builder

Overrides

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

clearParameters()

public NearestNeighborQuery.Builder clearParameters()

Optional. Parameters that can be set to tune query on the fly.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.Builder

clearPerCrowdingAttributeNeighborCount()

public NearestNeighborQuery.Builder clearPerCrowdingAttributeNeighborCount()

Optional. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than sper_crowding_attribute_neighbor_count of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity.

int32 per_crowding_attribute_neighbor_count = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.Builder	This builder for chaining.

clearStringFilters()

public NearestNeighborQuery.Builder clearStringFilters()

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.Builder

clone()

public NearestNeighborQuery.Builder clone()

Returns
Type	Description
NearestNeighborQuery.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public NearestNeighborQuery getDefaultInstanceForType()

Returns
Type	Description
NearestNeighborQuery

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEmbedding()

public NearestNeighborQuery.Embedding getEmbedding()

Optional. The embedding vector that be used for similar search.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.Embedding	The embedding.

getEmbeddingBuilder()

public NearestNeighborQuery.Embedding.Builder getEmbeddingBuilder()

Optional. The embedding vector that be used for similar search.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.Embedding.Builder

getEmbeddingOrBuilder()

public NearestNeighborQuery.EmbeddingOrBuilder getEmbeddingOrBuilder()

Optional. The embedding vector that be used for similar search.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.EmbeddingOrBuilder

getEntityId()

public String getEntityId()

Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.

string entity_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The entityId.

getEntityIdBytes()

public ByteString getEntityIdBytes()

Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.

string entity_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for entityId.

getInstanceCase()

public NearestNeighborQuery.InstanceCase getInstanceCase()

Returns
Type	Description
NearestNeighborQuery.InstanceCase

getNeighborCount()

public int getNeighborCount()

Optional. The number of similar entities to be retrieved from feature view for each query.

int32 neighbor_count = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The neighborCount.

getNumericFilters(int index)

public NearestNeighborQuery.NumericFilter getNumericFilters(int index)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NearestNeighborQuery.NumericFilter

getNumericFiltersBuilder(int index)

public NearestNeighborQuery.NumericFilter.Builder getNumericFiltersBuilder(int index)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NearestNeighborQuery.NumericFilter.Builder

getNumericFiltersBuilderList()

public List<NearestNeighborQuery.NumericFilter.Builder> getNumericFiltersBuilderList()

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getNumericFiltersCount()

public int getNumericFiltersCount()

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getNumericFiltersList()

public List<NearestNeighborQuery.NumericFilter> getNumericFiltersList()

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<NumericFilter>

getNumericFiltersOrBuilder(int index)

public NearestNeighborQuery.NumericFilterOrBuilder getNumericFiltersOrBuilder(int index)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NearestNeighborQuery.NumericFilterOrBuilder

getNumericFiltersOrBuilderList()

public List<? extends NearestNeighborQuery.NumericFilterOrBuilder> getNumericFiltersOrBuilderList()

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilterOrBuilder>

getParameters()

public NearestNeighborQuery.Parameters getParameters()

Optional. Parameters that can be set to tune query on the fly.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.Parameters	The parameters.

getParametersBuilder()

public NearestNeighborQuery.Parameters.Builder getParametersBuilder()

Optional. Parameters that can be set to tune query on the fly.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.Parameters.Builder

getParametersOrBuilder()

public NearestNeighborQuery.ParametersOrBuilder getParametersOrBuilder()

Optional. Parameters that can be set to tune query on the fly.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NearestNeighborQuery.ParametersOrBuilder

getPerCrowdingAttributeNeighborCount()

public int getPerCrowdingAttributeNeighborCount()

Optional. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than sper_crowding_attribute_neighbor_count of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity.

int32 per_crowding_attribute_neighbor_count = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The perCrowdingAttributeNeighborCount.

getStringFilters(int index)

public NearestNeighborQuery.StringFilter getStringFilters(int index)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NearestNeighborQuery.StringFilter

getStringFiltersBuilder(int index)

public NearestNeighborQuery.StringFilter.Builder getStringFiltersBuilder(int index)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NearestNeighborQuery.StringFilter.Builder

getStringFiltersBuilderList()

public List<NearestNeighborQuery.StringFilter.Builder> getStringFiltersBuilderList()

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getStringFiltersCount()

public int getStringFiltersCount()

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getStringFiltersList()

public List<NearestNeighborQuery.StringFilter> getStringFiltersList()

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<StringFilter>

getStringFiltersOrBuilder(int index)

public NearestNeighborQuery.StringFilterOrBuilder getStringFiltersOrBuilder(int index)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NearestNeighborQuery.StringFilterOrBuilder

getStringFiltersOrBuilderList()

public List<? extends NearestNeighborQuery.StringFilterOrBuilder> getStringFiltersOrBuilderList()

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilterOrBuilder>

hasEmbedding()

public boolean hasEmbedding()

Optional. The embedding vector that be used for similar search.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the embedding field is set.

hasEntityId()

public boolean hasEntityId()

Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.

string entity_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the entityId field is set.

hasParameters()

public boolean hasParameters()

Optional. Parameters that can be set to tune query on the fly.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the parameters field is set.

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

mergeEmbedding(NearestNeighborQuery.Embedding value)

public NearestNeighborQuery.Builder mergeEmbedding(NearestNeighborQuery.Embedding value)

Optional. The embedding vector that be used for similar search.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	NearestNeighborQuery.Embedding

Returns
Type	Description
NearestNeighborQuery.Builder

mergeFrom(NearestNeighborQuery other)

public NearestNeighborQuery.Builder mergeFrom(NearestNeighborQuery other)

Parameter
Name	Description
other	NearestNeighborQuery

Returns
Type	Description
NearestNeighborQuery.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
NearestNeighborQuery.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public NearestNeighborQuery.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
NearestNeighborQuery.Builder

Overrides

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

mergeParameters(NearestNeighborQuery.Parameters value)

public NearestNeighborQuery.Builder mergeParameters(NearestNeighborQuery.Parameters value)

Optional. Parameters that can be set to tune query on the fly.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	NearestNeighborQuery.Parameters

Returns
Type	Description
NearestNeighborQuery.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NearestNeighborQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
NearestNeighborQuery.Builder

Overrides

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

removeNumericFilters(int index)

public NearestNeighborQuery.Builder removeNumericFilters(int index)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NearestNeighborQuery.Builder

removeStringFilters(int index)

public NearestNeighborQuery.Builder removeStringFilters(int index)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NearestNeighborQuery.Builder

setEmbedding(NearestNeighborQuery.Embedding value)

public NearestNeighborQuery.Builder setEmbedding(NearestNeighborQuery.Embedding value)

Optional. The embedding vector that be used for similar search.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	NearestNeighborQuery.Embedding

Returns
Type	Description
NearestNeighborQuery.Builder

setEmbedding(NearestNeighborQuery.Embedding.Builder builderForValue)

public NearestNeighborQuery.Builder setEmbedding(NearestNeighborQuery.Embedding.Builder builderForValue)

Optional. The embedding vector that be used for similar search.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	NearestNeighborQuery.Embedding.Builder

Returns
Type	Description
NearestNeighborQuery.Builder

setEntityId(String value)

public NearestNeighborQuery.Builder setEntityId(String value)

Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.

string entity_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The entityId to set.

Returns
Type	Description
NearestNeighborQuery.Builder	This builder for chaining.

setEntityIdBytes(ByteString value)

public NearestNeighborQuery.Builder setEntityIdBytes(ByteString value)

Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.

string entity_id = 1 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
NearestNeighborQuery.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
NearestNeighborQuery.Builder

Overrides

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

setNeighborCount(int value)

public NearestNeighborQuery.Builder setNeighborCount(int value)

Optional. The number of similar entities to be retrieved from feature view for each query.

int32 neighbor_count = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The neighborCount to set.

Returns
Type	Description
NearestNeighborQuery.Builder	This builder for chaining.

setNumericFilters(int index, NearestNeighborQuery.NumericFilter value)

public NearestNeighborQuery.Builder setNumericFilters(int index, NearestNeighborQuery.NumericFilter value)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	NearestNeighborQuery.NumericFilter

Returns
Type	Description
NearestNeighborQuery.Builder

setNumericFilters(int index, NearestNeighborQuery.NumericFilter.Builder builderForValue)

public NearestNeighborQuery.Builder setNumericFilters(int index, NearestNeighborQuery.NumericFilter.Builder builderForValue)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	NearestNeighborQuery.NumericFilter.Builder

Returns
Type	Description
NearestNeighborQuery.Builder

setParameters(NearestNeighborQuery.Parameters value)

public NearestNeighborQuery.Builder setParameters(NearestNeighborQuery.Parameters value)

Optional. Parameters that can be set to tune query on the fly.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	NearestNeighborQuery.Parameters

Returns
Type	Description
NearestNeighborQuery.Builder

setParameters(NearestNeighborQuery.Parameters.Builder builderForValue)

public NearestNeighborQuery.Builder setParameters(NearestNeighborQuery.Parameters.Builder builderForValue)

Optional. Parameters that can be set to tune query on the fly.

.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	NearestNeighborQuery.Parameters.Builder

Returns
Type	Description
NearestNeighborQuery.Builder

setPerCrowdingAttributeNeighborCount(int value)

public NearestNeighborQuery.Builder setPerCrowdingAttributeNeighborCount(int value)

Optional. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than sper_crowding_attribute_neighbor_count of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity.

int32 per_crowding_attribute_neighbor_count = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The perCrowdingAttributeNeighborCount to set.

Returns
Type	Description
NearestNeighborQuery.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
NearestNeighborQuery.Builder

Overrides

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

setStringFilters(int index, NearestNeighborQuery.StringFilter value)

public NearestNeighborQuery.Builder setStringFilters(int index, NearestNeighborQuery.StringFilter value)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	NearestNeighborQuery.StringFilter

Returns
Type	Description
NearestNeighborQuery.Builder

setStringFilters(int index, NearestNeighborQuery.StringFilter.Builder builderForValue)

public NearestNeighborQuery.Builder setStringFilters(int index, NearestNeighborQuery.StringFilter.Builder builderForValue)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	NearestNeighborQuery.StringFilter.Builder

Returns
Type	Description
NearestNeighborQuery.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final NearestNeighborQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
NearestNeighborQuery.Builder

Overrides

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