public static interface StructuredQuery.FindNearestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDistanceMeasure()
public abstract StructuredQuery.FindNearest.DistanceMeasure getDistanceMeasure()Required. The Distance Measure to use, required.
.google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.FindNearest.DistanceMeasure |
The distanceMeasure. |
getDistanceMeasureValue()
public abstract int getDistanceMeasureValue()Required. The Distance Measure to use, required.
.google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for distanceMeasure. |
getLimit()
public abstract Int32Value getLimit()Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
.google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Int32Value |
The limit. |
getLimitOrBuilder()
public abstract Int32ValueOrBuilder getLimitOrBuilder()Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
.google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Int32ValueOrBuilder |
|
getQueryVector()
public abstract Value getQueryVector()Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
.google.firestore.v1.Value query_vector = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Value |
The queryVector. |
getQueryVectorOrBuilder()
public abstract ValueOrBuilder getQueryVectorOrBuilder()Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
.google.firestore.v1.Value query_vector = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ValueOrBuilder |
|
getVectorField()
public abstract StructuredQuery.FieldReference getVectorField()Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
.google.firestore.v1.StructuredQuery.FieldReference vector_field = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.FieldReference |
The vectorField. |
getVectorFieldOrBuilder()
public abstract StructuredQuery.FieldReferenceOrBuilder getVectorFieldOrBuilder()Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
.google.firestore.v1.StructuredQuery.FieldReference vector_field = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
StructuredQuery.FieldReferenceOrBuilder |
|
hasLimit()
public abstract boolean hasLimit()Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
.google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the limit field is set. |
hasQueryVector()
public abstract boolean hasQueryVector()Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
.google.firestore.v1.Value query_vector = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the queryVector field is set. |
hasVectorField()
public abstract boolean hasVectorField()Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
.google.firestore.v1.StructuredQuery.FieldReference vector_field = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the vectorField field is set. |