Highlight (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.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
```
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Highlight()

Constructors
Constructor and Description
`Highlight()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Highlight`	`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.
`Boolean`	`getTopAnswer()` Indicates whether the response is the best response.
`String`	`getType()` The highlight type.
`int`	`hashCode()`
`Boolean`	`isTopAnswer()` Indicates whether the response is the best response.
`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.
`void`	`setTopAnswer(Boolean topAnswer)` Indicates whether the response is the best response.
`void`	`setType(String type)` The highlight type.
`String`	`toString()` Returns a string representation of this object.
`Highlight`	`withBeginOffset(Integer beginOffset)` The zero-based location in the response string where the highlight starts.
`Highlight`	`withEndOffset(Integer endOffset)` The zero-based location in the response string where the highlight ends.
`Highlight`	`withTopAnswer(Boolean topAnswer)` Indicates whether the response is the best response.
`Highlight`	`withType(HighlightType type)` The highlight type.
`Highlight`	`withType(String type)` The highlight type.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Highlight
```
public Highlight()
```
- 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 Highlight 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 Highlight 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.
  - setTopAnswer
```
public void setTopAnswer(Boolean topAnswer)
```
    Indicates whether the response is the best response. True if this is the best response; otherwise, false.
    
    Parameters:
    
    topAnswer - Indicates whether the response is the best response. True if this is the best response; otherwise, false.
  - getTopAnswer
```
public Boolean getTopAnswer()
```
    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.
  - withTopAnswer
```
public Highlight withTopAnswer(Boolean topAnswer)
```
    Indicates whether the response is the best response. True if this is the best response; otherwise, false.
    
    Parameters:
    
    topAnswer - Indicates whether the response is the best response. True if this is the best response; otherwise, false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isTopAnswer
```
public Boolean isTopAnswer()
```
    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.
  - setType
```
public void setType(String type)
```
    The highlight type.
    
    Parameters:
    
    type - The highlight type.
    
    See Also:
    
    HighlightType
  - getType
```
public String getType()
```
    The highlight type.
    
    Returns:
    
    The highlight type.
    
    See Also:
    
    HighlightType
  - withType
```
public Highlight withType(String type)
```
    The highlight type.
    
    Parameters:
    
    type - The highlight type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HighlightType
  - withType
```
public Highlight withType(HighlightType type)
```
    The highlight type.
    
    Parameters:
    
    type - The highlight type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HighlightType
  - 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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class Highlight

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Highlight

Method Detail

setBeginOffset

getBeginOffset

withBeginOffset

setEndOffset

getEndOffset

withEndOffset

setTopAnswer

getTopAnswer

withTopAnswer

isTopAnswer

setType

getType

withType

withType

toString

equals

hashCode

clone

marshall