com.amazonaws.services.kendra.model

Class TableExcerpt

java.lang.Object

com.amazonaws.services.kendra.model.TableExcerpt

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

An excerpt from a table within a document. The table excerpt displays up to five columns and three rows, depending on how many table cells are relevant to the query and how many columns are available in the original table. The top most relevant cell is displayed in the table excerpt, along with the next most relevant cells.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TableExcerpt()

Method Summary

Modifier and Type	Method and Description
TableExcerpt	clone()
boolean	equals(Object obj)
List<TableRow>	getRows() A list of rows in the table excerpt.
Integer	getTotalNumberOfRows() A count of the number of rows in the original table within the document.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setRows(Collection<TableRow> rows) A list of rows in the table excerpt.
void	setTotalNumberOfRows(Integer totalNumberOfRows) A count of the number of rows in the original table within the document.
String	toString() Returns a string representation of this object.
TableExcerpt	withRows(Collection<TableRow> rows) A list of rows in the table excerpt.
TableExcerpt	withRows(TableRow... rows) A list of rows in the table excerpt.
TableExcerpt	withTotalNumberOfRows(Integer totalNumberOfRows) A count of the number of rows in the original table within the document.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TableExcerpt

public TableExcerpt()

Method Detail

getRows

public List<TableRow> getRows()

A list of rows in the table excerpt.

Returns:

A list of rows in the table excerpt.

setRows

public void setRows(Collection<TableRow> rows)

A list of rows in the table excerpt.

Parameters:

rows - A list of rows in the table excerpt.

withRows

public TableExcerpt withRows(TableRow... rows)

A list of rows in the table excerpt.

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

Parameters:

rows - A list of rows in the table excerpt.

Returns:

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

withRows

public TableExcerpt withRows(Collection<TableRow> rows)

A list of rows in the table excerpt.

Parameters:

rows - A list of rows in the table excerpt.

Returns:

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

setTotalNumberOfRows

public void setTotalNumberOfRows(Integer totalNumberOfRows)

A count of the number of rows in the original table within the document.

Parameters:

totalNumberOfRows - A count of the number of rows in the original table within the document.

getTotalNumberOfRows

public Integer getTotalNumberOfRows()

A count of the number of rows in the original table within the document.

Returns:

A count of the number of rows in the original table within the document.

withTotalNumberOfRows

public TableExcerpt withTotalNumberOfRows(Integer totalNumberOfRows)

A count of the number of rows in the original table within the document.

Parameters:

totalNumberOfRows - A count of the number of rows in the original table within the document.

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