com.amazonaws.services.kendra.model

Class TextWithHighlights

java.lang.Object

com.amazonaws.services.kendra.model.TextWithHighlights

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Provides text and information about where to highlight the text.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextWithHighlights()

Method Summary

Modifier and Type	Method and Description
TextWithHighlights	clone()
boolean	equals(Object obj)
List<Highlight>	getHighlights() The beginning and end of the text that should be highlighted.
String	getText() The text to display to the user.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setHighlights(Collection<Highlight> highlights) The beginning and end of the text that should be highlighted.
void	setText(String text) The text to display to the user.
String	toString() Returns a string representation of this object.
TextWithHighlights	withHighlights(Collection<Highlight> highlights) The beginning and end of the text that should be highlighted.
TextWithHighlights	withHighlights(Highlight... highlights) The beginning and end of the text that should be highlighted.
TextWithHighlights	withText(String text) The text to display to the user.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextWithHighlights

public TextWithHighlights()

Method Detail

setText

public void setText(String text)

The text to display to the user.

Parameters:

text - The text to display to the user.

getText

public String getText()

The text to display to the user.

Returns:

The text to display to the user.

withText

public TextWithHighlights withText(String text)

The text to display to the user.

Parameters:

text - The text to display to the user.

Returns:

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

getHighlights

public List<Highlight> getHighlights()

The beginning and end of the text that should be highlighted.

Returns:

The beginning and end of the text that should be highlighted.

setHighlights

public void setHighlights(Collection<Highlight> highlights)

The beginning and end of the text that should be highlighted.

Parameters:

highlights - The beginning and end of the text that should be highlighted.

withHighlights

public TextWithHighlights withHighlights(Highlight... highlights)

The beginning and end of the text that should be highlighted.

NOTE: This method appends the values to the existing list (if any). Use setHighlights(java.util.Collection) or withHighlights(java.util.Collection) if you want to override the existing values.

Parameters:

highlights - The beginning and end of the text that should be highlighted.

Returns:

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

withHighlights

public TextWithHighlights withHighlights(Collection<Highlight> highlights)

The beginning and end of the text that should be highlighted.

Parameters:

highlights - The beginning and end of the text that should be highlighted.

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 TextWithHighlights 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.