Package org.opensearch.protobufs

Class GeoDistanceQuery

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.opensearch.protobufs.GeoDistanceQuery
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, GeoDistanceQueryOrBuilder
public final class GeoDistanceQuery extends com.google.protobuf.GeneratedMessageV3 implements GeoDistanceQueryOrBuilder
Protobuf type org.opensearch.protobufs.GeoDistanceQuery
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    GeoDistanceQuery.Builder
    Protobuf type org.opensearch.protobufs.GeoDistanceQuery

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BOOST_FIELD_NUMBER
     
    static final int
    DISTANCE_FIELD_NUMBER
     
    static final int
    DISTANCE_TYPE_FIELD_NUMBER
     
    static final int
    IGNORE_UNMAPPED_FIELD_NUMBER
     
    static final int
    LOCATION_FIELD_NUMBER
     
    static final int
    UNIT_FIELD_NUMBER
     
    static final int
    VALIDATION_METHOD_FIELD_NUMBER
     
    static final int
    X_NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsLocation(String key)
    map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    boolean
    equals(Object obj)
     
    float
    getBoost()
    optional float boost = 2 [json_name = "boost"];
    static GeoDistanceQuery
    getDefaultInstance()
     
    GeoDistanceQuery
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDistance()
    string distance = 1 [json_name = "distance"];
    com.google.protobuf.ByteString
    getDistanceBytes()
    string distance = 1 [json_name = "distance"];
    GeoDistanceType
    getDistanceType()
    optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
    int
    getDistanceTypeValue()
    optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
    boolean
    getIgnoreUnmapped()
    optional bool ignore_unmapped = 6 [json_name = "ignoreUnmapped"];
    Map<String,GeoLocation>
    getLocation()
    Deprecated.
    int
    getLocationCount()
    map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    Map<String,GeoLocation>
    getLocationMap()
    map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    GeoLocation
    getLocationOrDefault(String key, GeoLocation defaultValue)
    map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    GeoLocation
    getLocationOrThrow(String key)
    map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
    com.google.protobuf.Parser<GeoDistanceQuery>
    getParserForType()
     
    int
    getSerializedSize()
     
    DistanceUnit
    getUnit()
    optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
    int
    getUnitValue()
    optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
    GeoValidationMethod
    getValidationMethod()
    optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
    int
    getValidationMethodValue()
    optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
    String
    getXName()
    optional string x_name = 3 [json_name = "xName"];
    com.google.protobuf.ByteString
    getXNameBytes()
    optional string x_name = 3 [json_name = "xName"];
    boolean
    hasBoost()
    optional float boost = 2 [json_name = "boost"];
    boolean
    hasDistanceType()
    optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
    int
    hashCode()
     
    boolean
    hasIgnoreUnmapped()
    optional bool ignore_unmapped = 6 [json_name = "ignoreUnmapped"];
    boolean
    hasUnit()
    optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
    boolean
    hasValidationMethod()
    optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
    boolean
    hasXName()
    optional string x_name = 3 [json_name = "xName"];
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static GeoDistanceQuery.Builder
    newBuilder()
     
    static GeoDistanceQuery.Builder
    newBuilder(GeoDistanceQuery prototype)
     
    GeoDistanceQuery.Builder
    newBuilderForType()
     
    protected GeoDistanceQuery.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static GeoDistanceQuery
    parseDelimitedFrom(InputStream input)
     
    static GeoDistanceQuery
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GeoDistanceQuery
    parseFrom(byte[] data)
     
    static GeoDistanceQuery
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GeoDistanceQuery
    parseFrom(com.google.protobuf.ByteString data)
     
    static GeoDistanceQuery
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GeoDistanceQuery
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static GeoDistanceQuery
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GeoDistanceQuery
    parseFrom(InputStream input)
     
    static GeoDistanceQuery
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GeoDistanceQuery
    parseFrom(ByteBuffer data)
     
    static GeoDistanceQuery
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<GeoDistanceQuery>
    parser()
     
    GeoDistanceQuery.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • DISTANCE_FIELD_NUMBER

      public static final int DISTANCE_FIELD_NUMBER
      See Also:

    • BOOST_FIELD_NUMBER

      public static final int BOOST_FIELD_NUMBER
      See Also:

    • X_NAME_FIELD_NUMBER

      public static final int X_NAME_FIELD_NUMBER
      See Also:

    • DISTANCE_TYPE_FIELD_NUMBER

      public static final int DISTANCE_TYPE_FIELD_NUMBER
      See Also:

    • VALIDATION_METHOD_FIELD_NUMBER

      public static final int VALIDATION_METHOD_FIELD_NUMBER
      See Also:

    • IGNORE_UNMAPPED_FIELD_NUMBER

      public static final int IGNORE_UNMAPPED_FIELD_NUMBER
      See Also:

    • UNIT_FIELD_NUMBER

      public static final int UNIT_FIELD_NUMBER
      See Also:

    • LOCATION_FIELD_NUMBER

      public static final int LOCATION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getDistance

      public String getDistance()
      string distance = 1 [json_name = "distance"];
      Specified by:
      getDistance in interface GeoDistanceQueryOrBuilder
      Returns:
      The distance.

    • getDistanceBytes

      public com.google.protobuf.ByteString getDistanceBytes()
      string distance = 1 [json_name = "distance"];
      Specified by:
      getDistanceBytes in interface GeoDistanceQueryOrBuilder
      Returns:
      The bytes for distance.

    • hasBoost

      public boolean hasBoost()
      optional float boost = 2 [json_name = "boost"];
      Specified by:
      hasBoost in interface GeoDistanceQueryOrBuilder
      Returns:
      Whether the boost field is set.

    • getBoost

      public float getBoost()
      optional float boost = 2 [json_name = "boost"];
      Specified by:
      getBoost in interface GeoDistanceQueryOrBuilder
      Returns:
      The boost.

    • hasXName

      public boolean hasXName()
      optional string x_name = 3 [json_name = "xName"];
      Specified by:
      hasXName in interface GeoDistanceQueryOrBuilder
      Returns:
      Whether the xName field is set.

    • getXName

      public String getXName()
      optional string x_name = 3 [json_name = "xName"];
      Specified by:
      getXName in interface GeoDistanceQueryOrBuilder
      Returns:
      The xName.

    • getXNameBytes

      public com.google.protobuf.ByteString getXNameBytes()
      optional string x_name = 3 [json_name = "xName"];
      Specified by:
      getXNameBytes in interface GeoDistanceQueryOrBuilder
      Returns:
      The bytes for xName.

    • hasDistanceType

      public boolean hasDistanceType()
      optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
      Specified by:
      hasDistanceType in interface GeoDistanceQueryOrBuilder
      Returns:
      Whether the distanceType field is set.

    • getDistanceTypeValue

      public int getDistanceTypeValue()
      optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
      Specified by:
      getDistanceTypeValue in interface GeoDistanceQueryOrBuilder
      Returns:
      The enum numeric value on the wire for distanceType.

    • getDistanceType

      public GeoDistanceType getDistanceType()
      optional .org.opensearch.protobufs.GeoDistanceType distance_type = 4 [json_name = "distanceType"];
      Specified by:
      getDistanceType in interface GeoDistanceQueryOrBuilder
      Returns:
      The distanceType.

    • hasValidationMethod

      public boolean hasValidationMethod()
      optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
      Specified by:
      hasValidationMethod in interface GeoDistanceQueryOrBuilder
      Returns:
      Whether the validationMethod field is set.

    • getValidationMethodValue

      public int getValidationMethodValue()
      optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
      Specified by:
      getValidationMethodValue in interface GeoDistanceQueryOrBuilder
      Returns:
      The enum numeric value on the wire for validationMethod.

    • getValidationMethod

      public GeoValidationMethod getValidationMethod()
      optional .org.opensearch.protobufs.GeoValidationMethod validation_method = 5 [json_name = "validationMethod"];
      Specified by:
      getValidationMethod in interface GeoDistanceQueryOrBuilder
      Returns:
      The validationMethod.

    • hasIgnoreUnmapped

      public boolean hasIgnoreUnmapped()
      optional bool ignore_unmapped = 6 [json_name = "ignoreUnmapped"];
      Specified by:
      hasIgnoreUnmapped in interface GeoDistanceQueryOrBuilder
      Returns:
      Whether the ignoreUnmapped field is set.

    • getIgnoreUnmapped

      public boolean getIgnoreUnmapped()
      optional bool ignore_unmapped = 6 [json_name = "ignoreUnmapped"];
      Specified by:
      getIgnoreUnmapped in interface GeoDistanceQueryOrBuilder
      Returns:
      The ignoreUnmapped.

    • hasUnit

      public boolean hasUnit()
      optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
      Specified by:
      hasUnit in interface GeoDistanceQueryOrBuilder
      Returns:
      Whether the unit field is set.

    • getUnitValue

      public int getUnitValue()
      optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
      Specified by:
      getUnitValue in interface GeoDistanceQueryOrBuilder
      Returns:
      The enum numeric value on the wire for unit.

    • getUnit

      public DistanceUnit getUnit()
      optional .org.opensearch.protobufs.DistanceUnit unit = 7 [json_name = "unit"];
      Specified by:
      getUnit in interface GeoDistanceQueryOrBuilder
      Returns:
      The unit.

    • getLocationCount

      public int getLocationCount()
      Description copied from interface: GeoDistanceQueryOrBuilder
      map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
      Specified by:
      getLocationCount in interface GeoDistanceQueryOrBuilder

    • containsLocation

      public boolean containsLocation(String key)
      map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
      Specified by:
      containsLocation in interface GeoDistanceQueryOrBuilder

    • getLocation

      @Deprecated public Map<String,GeoLocation> getLocation()
      Deprecated.
      Use getLocationMap() instead.
      Specified by:
      getLocation in interface GeoDistanceQueryOrBuilder

    • getLocationMap

      public Map<String,GeoLocation> getLocationMap()
      map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
      Specified by:
      getLocationMap in interface GeoDistanceQueryOrBuilder

    • getLocationOrDefault

      public GeoLocation getLocationOrDefault(String key, GeoLocation defaultValue)
      map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
      Specified by:
      getLocationOrDefault in interface GeoDistanceQueryOrBuilder

    • getLocationOrThrow

      public GeoLocation getLocationOrThrow(String key)
      map<string, .org.opensearch.protobufs.GeoLocation> location = 8 [json_name = "location"];
      Specified by:
      getLocationOrThrow in interface GeoDistanceQueryOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static GeoDistanceQuery parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GeoDistanceQuery parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GeoDistanceQuery parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GeoDistanceQuery parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GeoDistanceQuery parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GeoDistanceQuery parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GeoDistanceQuery parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GeoDistanceQuery parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GeoDistanceQuery parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GeoDistanceQuery parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GeoDistanceQuery parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GeoDistanceQuery parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public GeoDistanceQuery.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static GeoDistanceQuery.Builder newBuilder()

    • newBuilder

      public static GeoDistanceQuery.Builder newBuilder(GeoDistanceQuery prototype)

    • toBuilder

      public GeoDistanceQuery.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected GeoDistanceQuery.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static GeoDistanceQuery getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<GeoDistanceQuery> parser()

    • getParserForType

      public com.google.protobuf.Parser<GeoDistanceQuery> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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