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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AutocompleteAddressHighlights.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<Highlight>`	`addressNumber()`	The house number or address results should have.
`List<Highlight>`	`block()`	Name of the block.
`static AutocompleteAddressHighlights.Builder`	`builder()`
`List<Highlight>`	`building()`	The name of the building at the address.
`CountryHighlights`	`country()`	The alpha-2 or alpha-3 character code for the country that the results will be present in.
`List<Highlight>`	`district()`	The district or division of a city the results should be present in.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAddressNumber()`	For responses, this returns true if the service returned a value for the AddressNumber property.
`boolean`	`hasBlock()`	For responses, this returns true if the service returned a value for the Block property.
`boolean`	`hasBuilding()`	For responses, this returns true if the service returned a value for the Building property.
`boolean`	`hasDistrict()`	For responses, this returns true if the service returned a value for the District property.
`int`	`hashCode()`
`boolean`	`hasIntersection()`	For responses, this returns true if the service returned a value for the Intersection property.
`boolean`	`hasLabel()`	For responses, this returns true if the service returned a value for the Label property.
`boolean`	`hasLocality()`	For responses, this returns true if the service returned a value for the Locality property.
`boolean`	`hasPostalCode()`	For responses, this returns true if the service returned a value for the PostalCode property.
`boolean`	`hasStreet()`	For responses, this returns true if the service returned a value for the Street property.
`boolean`	`hasSubBlock()`	For responses, this returns true if the service returned a value for the SubBlock property.
`boolean`	`hasSubDistrict()`	For responses, this returns true if the service returned a value for the SubDistrict property.
`List<List<Highlight>>`	`intersection()`	Name of the streets in the intersection.
`List<Highlight>`	`label()`	Indicates the starting and ending indexes for result items where they are identified to match the input query.
`List<Highlight>`	`locality()`	The city or locality results should be present in.
`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 posses.
`RegionHighlights`	`region()`	The region or state results should be to be present in.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AutocompleteAddressHighlights.Builder>`	`serializableBuilderClass()`
`List<Highlight>`	`street()`	The name of the street results should be present in.
`List<Highlight>`	`subBlock()`	Name of sub-block.
`List<Highlight>`	`subDistrict()`	Indicates the starting and ending index of the title in the text query that match the found title.
`SubRegionHighlights`	`subRegion()`	The sub-region or county for which results should be present in.
`AutocompleteAddressHighlights.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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 posses.
    
    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 posses.
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AutocompleteAddressHighlights.Builder,AutocompleteAddressHighlights>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class AutocompleteAddressHighlights

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasLabel

label

country

region

subRegion

hasLocality

locality

hasDistrict

district

hasSubDistrict

subDistrict

hasStreet

street

hasBlock

block

hasSubBlock

subBlock

hasIntersection

intersection

hasPostalCode

postalCode

hasAddressNumber

addressNumber

hasBuilding

building

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField