Class SearchPlaceIndexForTextSummary

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

A summary of the request sent by using SearchPlaceIndexForText.

See Also:

  • Method Details

    • text

      public final String text()

      The search text specified in the request.

      Returns:
      The search text specified in the request.

    • hasBiasPosition

      public final boolean hasBiasPosition()
      For responses, this returns true if the service returned a value for the BiasPosition 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.

    • biasPosition

      public final List<Double> biasPosition()

      Contains the coordinates for the optional bias position specified in the request.

      This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

      For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

      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 hasBiasPosition() method.

      Returns:
      Contains the coordinates for the optional bias position specified in the request.

      This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

      For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

    • hasFilterBBox

      public final boolean hasFilterBBox()
      For responses, this returns true if the service returned a value for the FilterBBox 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.

    • filterBBox

      public final List<Double> filterBBox()

      Contains the coordinates for the optional bounding box 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 hasFilterBBox() method.

      Returns:
      Contains the coordinates for the optional bounding box specified in the request.

    • hasFilterCountries

      public final boolean hasFilterCountries()
      For responses, this returns true if the service returned a value for the FilterCountries 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.

    • filterCountries

      public final List<String> filterCountries()

      Contains the optional country filter 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 hasFilterCountries() method.

      Returns:
      Contains the optional country filter specified in the request.

    • maxResults

      public final Integer maxResults()

      Contains the optional result count limit specified in the request.

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

    • hasResultBBox

      public final boolean hasResultBBox()
      For responses, this returns true if the service returned a value for the ResultBBox 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.

    • resultBBox

      public final List<Double> resultBBox()

      The bounding box that fully contains all search results.

      If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

      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 hasResultBBox() method.

      Returns:
      The bounding box that fully contains all search results.

      If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

    • 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.

    • hasFilterCategories

      public final boolean hasFilterCategories()
      For responses, this returns true if the service returned a value for the FilterCategories 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.

    • filterCategories

      public final List<String> filterCategories()

      The optional category filter 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 hasFilterCategories() method.

      Returns:
      The optional category filter specified in the request.

    • toBuilder

      public SearchPlaceIndexForTextSummary.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<SearchPlaceIndexForTextSummary.Builder,SearchPlaceIndexForTextSummary>
      Returns:
      a builder for type T

    • builder

      public static SearchPlaceIndexForTextSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SearchPlaceIndexForTextSummary.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.