NearestNeighborQueryOrBuilder (proto-google-cloud-aiplatform-v1beta1 0.73.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

NearestNeighborQuery, NearestNeighborQuery.Builder
```
public interface NearestNeighborQueryOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`NearestNeighborQuery.Embedding`	`getEmbedding()` Optional.
`NearestNeighborQuery.EmbeddingOrBuilder`	`getEmbeddingOrBuilder()` Optional.
`String`	`getEntityId()` Optional.
`com.google.protobuf.ByteString`	`getEntityIdBytes()` Optional.
`NearestNeighborQuery.InstanceCase`	`getInstanceCase()`
`int`	`getNeighborCount()` Optional.
`NearestNeighborQuery.NumericFilter`	`getNumericFilters(int index)` Optional.
`int`	`getNumericFiltersCount()` Optional.
`List<NearestNeighborQuery.NumericFilter>`	`getNumericFiltersList()` Optional.
`NearestNeighborQuery.NumericFilterOrBuilder`	`getNumericFiltersOrBuilder(int index)` Optional.
`List<? extends NearestNeighborQuery.NumericFilterOrBuilder>`	`getNumericFiltersOrBuilderList()` Optional.
`NearestNeighborQuery.Parameters`	`getParameters()` Optional.
`NearestNeighborQuery.ParametersOrBuilder`	`getParametersOrBuilder()` Optional.
`int`	`getPerCrowdingAttributeNeighborCount()` Optional.
`NearestNeighborQuery.StringFilter`	`getStringFilters(int index)` Optional.
`int`	`getStringFiltersCount()` Optional.
`List<NearestNeighborQuery.StringFilter>`	`getStringFiltersList()` Optional.
`NearestNeighborQuery.StringFilterOrBuilder`	`getStringFiltersOrBuilder(int index)` Optional.
`List<? extends NearestNeighborQuery.StringFilterOrBuilder>`	`getStringFiltersOrBuilderList()` Optional.
`boolean`	`hasEmbedding()` Optional.
`boolean`	`hasEntityId()` Optional.
`boolean`	`hasParameters()` Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

- Method Detail
  - hasEntityId
```
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:
    
    Whether the entityId field is set.
  - getEntityId
```
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:
    
    The entityId.
  - getEntityIdBytes
```
com.google.protobuf.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:
    
    The bytes for entityId.
  - hasEmbedding
```
boolean hasEmbedding()
```
```
 Optional. The embedding vector that be used for similar search.
 
```
    .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the embedding field is set.
  - getEmbedding
```
NearestNeighborQuery.Embedding getEmbedding()
```
```
 Optional. The embedding vector that be used for similar search.
 
```
    .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The embedding.
  - getEmbeddingOrBuilder
```
NearestNeighborQuery.EmbeddingOrBuilder getEmbeddingOrBuilder()
```
```
 Optional. The embedding vector that be used for similar search.
 
```
    .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];
  - getNeighborCount
```
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:
    
    The neighborCount.
  - getStringFiltersList
```
List<NearestNeighborQuery.StringFilter> getStringFiltersList()
```
```
 Optional. The list of string filters.
 
```
    repeated .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];
  - getStringFilters
```
NearestNeighborQuery.StringFilter getStringFilters(int index)
```
```
 Optional. The list of string filters.
 
```
    repeated .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];
  - getStringFiltersCount
```
int getStringFiltersCount()
```
```
 Optional. The list of string filters.
 
```
    repeated .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];
  - getStringFiltersOrBuilderList
```
List<? extends NearestNeighborQuery.StringFilterOrBuilder> getStringFiltersOrBuilderList()
```
```
 Optional. The list of string filters.
 
```
    repeated .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];
  - getStringFiltersOrBuilder
```
NearestNeighborQuery.StringFilterOrBuilder getStringFiltersOrBuilder(int index)
```
```
 Optional. The list of string filters.
 
```
    repeated .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];
  - getNumericFiltersList
```
List<NearestNeighborQuery.NumericFilter> getNumericFiltersList()
```
```
 Optional. The list of numeric filters.
 
```
    repeated .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
  - getNumericFilters
```
NearestNeighborQuery.NumericFilter getNumericFilters(int index)
```
```
 Optional. The list of numeric filters.
 
```
    repeated .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
  - getNumericFiltersCount
```
int getNumericFiltersCount()
```
```
 Optional. The list of numeric filters.
 
```
    repeated .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
  - getNumericFiltersOrBuilderList
```
List<? extends NearestNeighborQuery.NumericFilterOrBuilder> getNumericFiltersOrBuilderList()
```
```
 Optional. The list of numeric filters.
 
```
    repeated .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
  - getNumericFiltersOrBuilder
```
NearestNeighborQuery.NumericFilterOrBuilder getNumericFiltersOrBuilder(int index)
```
```
 Optional. The list of numeric filters.
 
```
    repeated .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
  - getPerCrowdingAttributeNeighborCount
```
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:
    
    The perCrowdingAttributeNeighborCount.
  - hasParameters
```
boolean hasParameters()
```
```
 Optional. Parameters that can be set to tune query on the fly.
 
```
    .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the parameters field is set.
  - getParameters
```
NearestNeighborQuery.Parameters getParameters()
```
```
 Optional. Parameters that can be set to tune query on the fly.
 
```
    .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The parameters.
  - getParametersOrBuilder
```
NearestNeighborQuery.ParametersOrBuilder getParametersOrBuilder()
```
```
 Optional. Parameters that can be set to tune query on the fly.
 
```
    .google.cloud.aiplatform.v1beta1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];
  - getInstanceCase
```
NearestNeighborQuery.InstanceCase getInstanceCase()
```

Interface NearestNeighborQueryOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Method Detail

hasEntityId

getEntityId

getEntityIdBytes

hasEmbedding

getEmbedding

getEmbeddingOrBuilder

getNeighborCount

getStringFiltersList

getStringFilters

getStringFiltersCount

getStringFiltersOrBuilderList

getStringFiltersOrBuilder

getNumericFiltersList

getNumericFilters

getNumericFiltersCount

getNumericFiltersOrBuilderList

getNumericFiltersOrBuilder

getPerCrowdingAttributeNeighborCount

hasParameters

getParameters

getParametersOrBuilder

getInstanceCase