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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListTableRowsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListTableRowsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRowIds()	For responses, this returns true if the service returned a value for the RowIds property.
Integer	maxResults()	The maximum number of rows to return in each page of the results.
String	nextToken()	This parameter is optional.
List<String>	rowIds()	This parameter is optional.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTableRowsRequest.Builder>	serializableBuilderClass()
String	tableId()	The ID of the table whose rows are being retrieved.
ListTableRowsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workbookId()	The ID of the workbook that contains the table whose rows are being retrieved.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTableRowsRequest.Builder,ListTableRowsRequest>

Specified by:

toBuilder in class HoneycodeRequest

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)

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo