Class Highlight
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Highlight.Builder,
Highlight>
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
The zero-based location in the response string where the highlight starts.static Highlight.Builder
builder()
final Integer
The zero-based location in the response string where the highlight ends.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()
static Class
<? extends Highlight.Builder> Take this object and create a builder that contains all of the current property values of this object.final Boolean
Indicates whether the response is the best response.final String
toString()
Returns a string representation of this object.final HighlightType
type()
The highlight type.final String
The highlight type.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
beginOffset
The zero-based location in the response string where the highlight starts.
- Returns:
- The zero-based location in the response string where the highlight starts.
-
endOffset
The zero-based location in the response string where the highlight ends.
- Returns:
- The zero-based location in the response string where the highlight ends.
-
topAnswer
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
- Returns:
- Indicates whether the response is the best response. True if this is the best response; otherwise, false.
-
type
The highlight type.
If the service returns an enum value that is not available in the current SDK version,
type
will returnHighlightType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The highlight type.
- See Also:
-
typeAsString
The highlight type.
If the service returns an enum value that is not available in the current SDK version,
type
will returnHighlightType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The highlight type.
- See Also:
-
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<Highlight.Builder,
Highlight> - 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
-