Class SearchPlaceIndexForPositionSummary

java.lang.Object
software.amazon.awssdk.services.location.model.SearchPlaceIndexForPositionSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SearchPlaceIndexForPositionSummary.Builder,SearchPlaceIndexForPositionSummary>
@Generated("software.amazon.awssdk:codegen") public final class SearchPlaceIndexForPositionSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SearchPlaceIndexForPositionSummary.Builder,SearchPlaceIndexForPositionSummary>

A summary of the request sent by using SearchPlaceIndexForPosition.

See Also:

  • Method Details

    • hasPosition

      public final boolean hasPosition()
      For responses, this returns true if the service returned a value for the Position property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • position

      public final List<Double> position()

      The position specified in the request.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPosition() method.

      Returns:
      The position specified in the request.

    • maxResults

      public final Integer maxResults()

      Contains the optional result count limit that is specified in the request.

      Default value: 50

      Returns:
      Contains the optional result count limit that is specified in the request.

      Default value: 50

    • dataSource

      public final String dataSource()

      The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

      • Esri

      • Grab

      • Here

      For more information about data providers, see Amazon Location Service data providers.

      Returns:
      The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

      • Esri

      • Grab

      • Here

      For more information about data providers, see Amazon Location Service data providers.

    • language

      public final String language()

      The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

      Returns:
      The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

    • toBuilder

      public SearchPlaceIndexForPositionSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchPlaceIndexForPositionSummary.Builder,SearchPlaceIndexForPositionSummary>
      Returns:
      a builder for type T

    • builder

      public static SearchPlaceIndexForPositionSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SearchPlaceIndexForPositionSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.