Interface GeoDistanceQueryOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GeoDistanceQuery, GeoDistanceQuery.Builder

public interface GeoDistanceQueryOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    float
    optional float boost = 2 [json_name = "boost"];
    string distance = 1 [json_name = "distance"];
    com.google.protobuf.ByteString
    string distance = 1 [json_name = "distance"];
    optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
    int
    optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
    boolean
    optional bool ignore_unmapped = 6 [json_name = "ignoreUnmapped"];
    Deprecated.
    int
    map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
    int
    optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
    optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
    int
    optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
    optional string x_name = 3 [json_name = "xName"];
    com.google.protobuf.ByteString
    optional string x_name = 3 [json_name = "xName"];
    boolean
    optional float boost = 2 [json_name = "boost"];
    boolean
    optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
    boolean
    optional bool ignore_unmapped = 6 [json_name = "ignoreUnmapped"];
    boolean
    optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
    boolean
    optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
    boolean
    optional string x_name = 3 [json_name = "xName"];

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getDistance

      String getDistance()
      string distance = 1 [json_name = "distance"];
      Returns:
      The distance.
    • getDistanceBytes

      com.google.protobuf.ByteString getDistanceBytes()
      string distance = 1 [json_name = "distance"];
      Returns:
      The bytes for distance.
    • hasBoost

      boolean hasBoost()
      optional float boost = 2 [json_name = "boost"];
      Returns:
      Whether the boost field is set.
    • getBoost

      float getBoost()
      optional float boost = 2 [json_name = "boost"];
      Returns:
      The boost.
    • hasXName

      boolean hasXName()
      optional string x_name = 3 [json_name = "xName"];
      Returns:
      Whether the xName field is set.
    • getXName

      String getXName()
      optional string x_name = 3 [json_name = "xName"];
      Returns:
      The xName.
    • getXNameBytes

      com.google.protobuf.ByteString getXNameBytes()
      optional string x_name = 3 [json_name = "xName"];
      Returns:
      The bytes for xName.
    • hasDistanceType

      boolean hasDistanceType()
      optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
      Returns:
      Whether the distanceType field is set.
    • getDistanceTypeValue

      int getDistanceTypeValue()
      optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
      Returns:
      The enum numeric value on the wire for distanceType.
    • getDistanceType

      GeoDistanceType getDistanceType()
      optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
      Returns:
      The distanceType.
    • hasValidationMethod

      boolean hasValidationMethod()
      optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
      Returns:
      Whether the validationMethod field is set.
    • getValidationMethodValue

      int getValidationMethodValue()
      optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
      Returns:
      The enum numeric value on the wire for validationMethod.
    • getValidationMethod

      GeoValidationMethod getValidationMethod()
      optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
      Returns:
      The validationMethod.
    • hasIgnoreUnmapped

      boolean hasIgnoreUnmapped()
      optional bool ignore_unmapped = 6 [json_name = "ignoreUnmapped"];
      Returns:
      Whether the ignoreUnmapped field is set.
    • getIgnoreUnmapped

      boolean getIgnoreUnmapped()
      optional bool ignore_unmapped = 6 [json_name = "ignoreUnmapped"];
      Returns:
      The ignoreUnmapped.
    • hasUnit

      boolean hasUnit()
      optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
      Returns:
      Whether the unit field is set.
    • getUnitValue

      int getUnitValue()
      optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
      Returns:
      The enum numeric value on the wire for unit.
    • getUnit

      DistanceUnit getUnit()
      optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
      Returns:
      The unit.
    • getLocationCount

      int getLocationCount()
      map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    • containsLocation

      boolean containsLocation(String key)
      map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    • getLocation

      Deprecated.
      Use getLocationMap() instead.
    • getLocationMap

      Map<String,GeoLocation> getLocationMap()
      map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    • getLocationOrDefault

      GeoLocation getLocationOrDefault(String key, GeoLocation defaultValue)
      map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    • getLocationOrThrow

      GeoLocation getLocationOrThrow(String key)
      map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];