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

Class SuggestHighlights

java.lang.Object

software.amazon.awssdk.services.geoplaces.model.SuggestHighlights

All Implemented Interfaces:

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

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

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	SuggestHighlights.Builder

Method Summary

Modifier and Type	Method	Description
SuggestAddressHighlights	address()	The place's address.
static SuggestHighlights.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTitle()	For responses, this returns true if the service returned a value for the Title property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SuggestHighlights.Builder>	serializableBuilderClass()
List<Highlight>	title()	Indicates the starting and ending index of the title in the text query that match the found title.
SuggestHighlights.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

hasTitle

public final boolean hasTitle()

For responses, this returns true if the service returned a value for the Title 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.

title

public final List<Highlight> title()

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

Returns:

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

address

public final SuggestAddressHighlights address()

The place's address.

Returns:

The place's address.

toBuilder

public SuggestHighlights.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SuggestHighlights.Builder,SuggestHighlights>

builder

public static SuggestHighlights.Builder builder()

serializableBuilderClass

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