Class GeocodeQueryComponents

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

A structured free text query allows you to search for places by the name or text representation of specific properties of the place.

See Also:

  • Method Details

    • country

      public final String country()

      The alpha-2 or alpha-3 character code for the country that the results will be present in.

      Returns:
      The alpha-2 or alpha-3 character code for the country that the results will be present in.

    • region

      public final String region()

      The region or state results should be to be present in.

      Example: North Rhine-Westphalia.

      Returns:
      The region or state results should be to be present in.

      Example: North Rhine-Westphalia.

    • subRegion

      public final String subRegion()

      The sub-region or county for which results should be present in.

      Returns:
      The sub-region or county for which results should be present in.

    • locality

      public final String locality()

      The city or locality results should be present in.

      Example: Vancouver.

      Returns:
      The city or locality results should be present in.

      Example: Vancouver.

    • district

      public final String district()

      The district or division of a city the results should be present in.

      Returns:
      The district or division of a city the results should be present in.

    • street

      public final String street()

      The name of the street results should be present in.

      Returns:
      The name of the street results should be present in.

    • addressNumber

      public final String addressNumber()

      The house number or address results should have.

      Returns:
      The house number or address results should have.

    • postalCode

      public final String postalCode()

      An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess.

      Returns:
      An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess.

    • toBuilder

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

    • builder

      public static GeocodeQueryComponents.Builder builder()

    • serializableBuilderClass

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