Class AutocompleteAddressHighlights

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

Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

See Also:

  • Method Details

    • hasLabel

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

    • label

      public final List<Highlight> label()

      Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.

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

      Returns:
      Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.

    • country

      public final CountryHighlights 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 RegionHighlights 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 SubRegionHighlights 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.

    • hasLocality

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

    • locality

      public final List<Highlight> locality()

      The city or locality results should be present in.

      Example: Vancouver.

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

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

      Example: Vancouver.

    • hasDistrict

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

    • district

      public final List<Highlight> district()

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

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

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

    • hasSubDistrict

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

    • subDistrict

      public final List<Highlight> subDistrict()

      Indicates the starting and ending index of the title in the text query that match the found title.

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

      Returns:
      Indicates the starting and ending index of the title in the text query that match the found title.

    • hasStreet

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

    • street

      public final List<Highlight> street()

      The name of the street results should be present in.

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

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

    • hasBlock

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

    • block

      public final List<Highlight> block()

      Name of the block.

      Example: Sunny Mansion 203 block: 2 Chome

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

      Returns:
      Name of the block.

      Example: Sunny Mansion 203 block: 2 Chome

    • hasSubBlock

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

    • subBlock

      public final List<Highlight> subBlock()

      Name of sub-block.

      Example: Sunny Mansion 203 sub-block: 4

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

      Returns:
      Name of sub-block.

      Example: Sunny Mansion 203 sub-block: 4

    • hasIntersection

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

    • intersection

      public final List<List<Highlight>> intersection()

      Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]

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

      Returns:
      Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]

    • hasPostalCode

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

    • postalCode

      public final List<Highlight> 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.

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

      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.

    • hasAddressNumber

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

    • addressNumber

      public final List<Highlight> addressNumber()

      The house number or address results should have.

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

      Returns:
      The house number or address results should have.

    • hasBuilding

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

    • building

      public final List<Highlight> building()

      The name of the building at the address.

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

      Returns:
      The name of the building at the address.

    • toBuilder

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

    • builder

      public static AutocompleteAddressHighlights.Builder builder()

    • serializableBuilderClass

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