com.amazonaws.services.kendra.model

Class SuggestionHighlight

java.lang.Object

com.amazonaws.services.kendra.model.SuggestionHighlight

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SuggestionHighlight
extends Object
implements Serializable, Cloneable, StructuredPojo

The text highlights for a single query suggestion.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SuggestionHighlight()

Method Summary

Modifier and Type	Method and Description
SuggestionHighlight	clone()
boolean	equals(Object obj)
Integer	getBeginOffset() The zero-based location in the response string where the highlight starts.
Integer	getEndOffset() The zero-based location in the response string where the highlight ends.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBeginOffset(Integer beginOffset) The zero-based location in the response string where the highlight starts.
void	setEndOffset(Integer endOffset) The zero-based location in the response string where the highlight ends.
String	toString() Returns a string representation of this object.
SuggestionHighlight	withBeginOffset(Integer beginOffset) The zero-based location in the response string where the highlight starts.
SuggestionHighlight	withEndOffset(Integer endOffset) The zero-based location in the response string where the highlight ends.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SuggestionHighlight

public SuggestionHighlight()

Method Detail

setBeginOffset

public void setBeginOffset(Integer beginOffset)

The zero-based location in the response string where the highlight starts.

Parameters:

beginOffset - The zero-based location in the response string where the highlight starts.

getBeginOffset

public Integer getBeginOffset()

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.

withBeginOffset

public SuggestionHighlight withBeginOffset(Integer beginOffset)

The zero-based location in the response string where the highlight starts.

Parameters:

beginOffset - The zero-based location in the response string where the highlight starts.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndOffset

public void setEndOffset(Integer endOffset)

The zero-based location in the response string where the highlight ends.

Parameters:

endOffset - The zero-based location in the response string where the highlight ends.

getEndOffset

public Integer getEndOffset()

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.

withEndOffset

public SuggestionHighlight withEndOffset(Integer endOffset)

The zero-based location in the response string where the highlight ends.

Parameters:

endOffset - The zero-based location in the response string where the highlight ends.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SuggestionHighlight clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.