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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TableExcerpt.Builder,TableExcerpt>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.