com.amazonaws.services.connectwisdom.model

Class Highlight

java.lang.Object

com.amazonaws.services.connectwisdom.model.Highlight

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Highlight()

Method Summary

Modifier and Type	Method and Description
Highlight	clone()
boolean	equals(Object obj)
Integer	getBeginOffsetInclusive() The offset for the start of the highlight.
Integer	getEndOffsetExclusive() The offset for the end of the highlight.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBeginOffsetInclusive(Integer beginOffsetInclusive) The offset for the start of the highlight.
void	setEndOffsetExclusive(Integer endOffsetExclusive) The offset for the end of the highlight.
String	toString() Returns a string representation of this object.
Highlight	withBeginOffsetInclusive(Integer beginOffsetInclusive) The offset for the start of the highlight.
Highlight	withEndOffsetExclusive(Integer endOffsetExclusive) The offset for the end of the highlight.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Highlight

public Highlight()

Method Detail

setBeginOffsetInclusive

public void setBeginOffsetInclusive(Integer beginOffsetInclusive)

The offset for the start of the highlight.

Parameters:

beginOffsetInclusive - The offset for the start of the highlight.

getBeginOffsetInclusive

public Integer getBeginOffsetInclusive()

The offset for the start of the highlight.

Returns:

The offset for the start of the highlight.

withBeginOffsetInclusive

public Highlight withBeginOffsetInclusive(Integer beginOffsetInclusive)

The offset for the start of the highlight.

Parameters:

beginOffsetInclusive - The offset for the start of the highlight.

Returns:

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

setEndOffsetExclusive

public void setEndOffsetExclusive(Integer endOffsetExclusive)

The offset for the end of the highlight.

Parameters:

endOffsetExclusive - The offset for the end of the highlight.

getEndOffsetExclusive

public Integer getEndOffsetExclusive()

The offset for the end of the highlight.

Returns:

The offset for the end of the highlight.

withEndOffsetExclusive

public Highlight withEndOffsetExclusive(Integer endOffsetExclusive)

The offset for the end of the highlight.

Parameters:

endOffsetExclusive - The offset for the end of the highlight.

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