Package software.amazon.awssdk.services.geoplaces.model

Class SuggestAddressHighlights

java.lang.Object

software.amazon.awssdk.services.geoplaces.model.SuggestAddressHighlights

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SuggestAddressHighlights.Builder,SuggestAddressHighlights>

@Generated("software.amazon.awssdk:codegen")
public final class SuggestAddressHighlights
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SuggestAddressHighlights.Builder,SuggestAddressHighlights>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SuggestAddressHighlights.Builder

Method Summary

Modifier and Type	Method	Description
static SuggestAddressHighlights.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLabel()	For responses, this returns true if the service returned a value for the Label property.
List<Highlight>	label()	Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SuggestAddressHighlights.Builder>	serializableBuilderClass()
SuggestAddressHighlights.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 of the places in the result which were identified to match the textQuery. This result is useful for providing emphasis to results where the user query directly matched to make selecting the correct result from a list easier for an end user.

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 of the places in the result which were identified to match the textQuery. This result is useful for providing emphasis to results where the user query directly matched to make selecting the correct result from a list easier for an end user.

toBuilder

public SuggestAddressHighlights.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SuggestAddressHighlights.Builder,SuggestAddressHighlights>

builder

public static SuggestAddressHighlights.Builder builder()

serializableBuilderClass

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