Package software.amazon.awssdk.services.honeycode.model

Class ListTableRowsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.honeycode.model.HoneycodeRequest
software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListTableRowsRequest.Builder,ListTableRowsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListTableRowsRequest extends HoneycodeRequest implements ToCopyableBuilder<ListTableRowsRequest.Builder,ListTableRowsRequest>

  • Method Details

    • workbookId

      public final String workbookId()

      The ID of the workbook that contains the table whose rows are being retrieved.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

      Returns:
      The ID of the workbook that contains the table whose rows are being retrieved.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

    • tableId

      public final String tableId()

      The ID of the table whose rows are being retrieved.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

      Returns:
      The ID of the table whose rows are being retrieved.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

    • hasRowIds

      public final boolean hasRowIds()
      For responses, this returns true if the service returned a value for the RowIds 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.

    • rowIds

      public final List<String> rowIds()

      This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.

      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 hasRowIds() method.

      Returns:
      This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.

    • maxResults

      public final Integer maxResults()

      The maximum number of rows to return in each page of the results.

      Returns:
      The maximum number of rows to return in each page of the results.

    • nextToken

      public final String nextToken()

      This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

      Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

      Returns:
      This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

      Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

    • toBuilder

      public ListTableRowsRequest.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<ListTableRowsRequest.Builder,ListTableRowsRequest>
      Specified by:
      toBuilder in class HoneycodeRequest
      Returns:
      a builder for type T

    • builder

      public static ListTableRowsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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