Package software.amazon.awssdk.services.kendra.model

Class TableExcerpt

java.lang.Object

software.amazon.awssdk.services.kendra.model.TableExcerpt

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TableExcerpt.Builder,TableExcerpt>

@Generated("software.amazon.awssdk:codegen")
public final class TableExcerpt
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TableExcerpt.Builder,TableExcerpt>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TableExcerpt.Builder

Method Summary

Modifier and Type	Method	Description
static TableExcerpt.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRows()	For responses, this returns true if the service returned a value for the Rows property.
List<TableRow>	rows()	A list of rows in the table excerpt.
List<SdkField<?>>	sdkFields()
static Class<? extends TableExcerpt.Builder>	serializableBuilderClass()
TableExcerpt.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	totalNumberOfRows()	A count of the number of rows in the original table within the document.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasRows

public final boolean hasRows()

For responses, this returns true if the service returned a value for the Rows property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

rows

public final List<TableRow> rows()

A list of rows in the table excerpt.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRows() method.

Returns:

A list of rows in the table excerpt.

totalNumberOfRows

public final Integer totalNumberOfRows()

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.

toBuilder

public TableExcerpt.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TableExcerpt.Builder,TableExcerpt>

builder

public static TableExcerpt.Builder builder()

serializableBuilderClass

public static Class<? extends TableExcerpt.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo