Package com.google.firestore.v1

Class StructuredQuery.FindNearest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>
com.google.firestore.v1.StructuredQuery.FindNearest.Builder
All Implemented Interfaces:
StructuredQuery.FindNearestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
StructuredQuery.FindNearest
public static final class StructuredQuery.FindNearest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder> implements StructuredQuery.FindNearestOrBuilder
 Nearest Neighbors search config. The ordering provided by FindNearest
 supersedes the order_by stage. If multiple documents have the same vector
 distance, the returned document order is not guaranteed to be stable
 between queries.
Protobuf type google.firestore.v1.StructuredQuery.FindNearest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>

    • clear

      public StructuredQuery.FindNearest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>

    • getDefaultInstanceForType

      public StructuredQuery.FindNearest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public StructuredQuery.FindNearest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public StructuredQuery.FindNearest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public StructuredQuery.FindNearest.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>

    • setField

      public StructuredQuery.FindNearest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>

    • clearField

      public StructuredQuery.FindNearest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>

    • clearOneof

      public StructuredQuery.FindNearest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>

    • setRepeatedField

      public StructuredQuery.FindNearest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>

    • addRepeatedField

      public StructuredQuery.FindNearest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>

    • mergeFrom

      public StructuredQuery.FindNearest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StructuredQuery.FindNearest.Builder>

    • mergeFrom

      public StructuredQuery.FindNearest.Builder mergeFrom(StructuredQuery.FindNearest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>

    • mergeFrom

      public StructuredQuery.FindNearest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StructuredQuery.FindNearest.Builder>
      Throws:
      IOException

    • hasVectorField

      public 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];
      Specified by:
      hasVectorField in interface StructuredQuery.FindNearestOrBuilder
      Returns:
      Whether the vectorField field is set.

    • getVectorField

      public 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];
      Specified by:
      getVectorField in interface StructuredQuery.FindNearestOrBuilder
      Returns:
      The vectorField.

    • setVectorField

      public StructuredQuery.FindNearest.Builder setVectorField(StructuredQuery.FieldReference value)
       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];

    • setVectorField

      public StructuredQuery.FindNearest.Builder setVectorField(StructuredQuery.FieldReference.Builder builderForValue)
       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];

    • mergeVectorField

      public StructuredQuery.FindNearest.Builder mergeVectorField(StructuredQuery.FieldReference value)
       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];

    • clearVectorField

      public StructuredQuery.FindNearest.Builder clearVectorField()
       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];

    • getVectorFieldBuilder

      public StructuredQuery.FieldReference.Builder getVectorFieldBuilder()
       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];

    • getVectorFieldOrBuilder

      public 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];
      Specified by:
      getVectorFieldOrBuilder in interface StructuredQuery.FindNearestOrBuilder

    • hasQueryVector

      public 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];
      Specified by:
      hasQueryVector in interface StructuredQuery.FindNearestOrBuilder
      Returns:
      Whether the queryVector field is set.

    • getQueryVector

      public 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];
      Specified by:
      getQueryVector in interface StructuredQuery.FindNearestOrBuilder
      Returns:
      The queryVector.

    • setQueryVector

      public StructuredQuery.FindNearest.Builder setQueryVector(Value value)
       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];

    • setQueryVector

      public StructuredQuery.FindNearest.Builder setQueryVector(Value.Builder builderForValue)
       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];

    • mergeQueryVector

      public StructuredQuery.FindNearest.Builder mergeQueryVector(Value value)
       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];

    • clearQueryVector

      public StructuredQuery.FindNearest.Builder clearQueryVector()
       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];

    • getQueryVectorBuilder

      public Value.Builder getQueryVectorBuilder()
       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];

    • getQueryVectorOrBuilder

      public 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];
      Specified by:
      getQueryVectorOrBuilder in interface StructuredQuery.FindNearestOrBuilder

    • getDistanceMeasureValue

      public int getDistanceMeasureValue()
       Required. The distance measure to use, required.
      .google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDistanceMeasureValue in interface StructuredQuery.FindNearestOrBuilder
      Returns:
      The enum numeric value on the wire for distanceMeasure.

    • setDistanceMeasureValue

      public StructuredQuery.FindNearest.Builder setDistanceMeasureValue(int value)
       Required. The distance measure to use, required.
      .google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for distanceMeasure to set.
      Returns:
      This builder for chaining.

    • getDistanceMeasure

      public 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];
      Specified by:
      getDistanceMeasure in interface StructuredQuery.FindNearestOrBuilder
      Returns:
      The distanceMeasure.

    • setDistanceMeasure

      public StructuredQuery.FindNearest.Builder setDistanceMeasure(StructuredQuery.FindNearest.DistanceMeasure value)
       Required. The distance measure to use, required.
      .google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The distanceMeasure to set.
      Returns:
      This builder for chaining.

    • clearDistanceMeasure

      public StructuredQuery.FindNearest.Builder clearDistanceMeasure()
       Required. The distance measure to use, required.
      .google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • hasLimit

      public 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];
      Specified by:
      hasLimit in interface StructuredQuery.FindNearestOrBuilder
      Returns:
      Whether the limit field is set.

    • getLimit

      public com.google.protobuf.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];
      Specified by:
      getLimit in interface StructuredQuery.FindNearestOrBuilder
      Returns:
      The limit.

    • setLimit

      public StructuredQuery.FindNearest.Builder setLimit(com.google.protobuf.Int32Value value)
       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];

    • setLimit

      public StructuredQuery.FindNearest.Builder setLimit(com.google.protobuf.Int32Value.Builder builderForValue)
       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];

    • mergeLimit

      public StructuredQuery.FindNearest.Builder mergeLimit(com.google.protobuf.Int32Value value)
       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];

    • clearLimit

      public StructuredQuery.FindNearest.Builder clearLimit()
       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];

    • getLimitBuilder

      public com.google.protobuf.Int32Value.Builder getLimitBuilder()
       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];

    • getLimitOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getLimitOrBuilder in interface StructuredQuery.FindNearestOrBuilder

    • setUnknownFields

      public final StructuredQuery.FindNearest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>

    • mergeUnknownFields

      public final StructuredQuery.FindNearest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.FindNearest.Builder>