Class TextWithHighlights
java.lang.Object
software.amazon.awssdk.services.kendra.model.TextWithHighlights
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TextWithHighlights.Builder,
TextWithHighlights>
@Generated("software.amazon.awssdk:codegen")
public final class TextWithHighlights
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TextWithHighlights.Builder,TextWithHighlights>
Provides text and information about where to highlight the text.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic TextWithHighlights.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Highlights property.The beginning and end of the text that should be highlighted.static Class
<? extends TextWithHighlights.Builder> final String
text()
The text to display to the user.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
text
The text to display to the user.
- Returns:
- The text to display to the user.
-
hasHighlights
public final boolean hasHighlights()For responses, this returns true if the service returned a value for the Highlights property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
highlights
The beginning and end of the text that should be highlighted.
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
hasHighlights()
method.- Returns:
- The beginning and end of the text that should be highlighted.
-
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 interfaceToCopyableBuilder<TextWithHighlights.Builder,
TextWithHighlights> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-