software.amazon.awssdk.services.honeycode.model

Class QueryTableRowsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<QueryTableRowsRequest.Builder,QueryTableRowsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class QueryTableRowsRequest
extends HoneycodeRequest
implements ToCopyableBuilder<QueryTableRowsRequest.Builder,QueryTableRowsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryTableRowsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static QueryTableRowsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
Filter	filterFormula() An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of rows to return in each page of the results.
String	nextToken() This parameter is optional.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryTableRowsRequest.Builder>	serializableBuilderClass()
String	tableId() The ID of the table whose rows are being queried.
QueryTableRowsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	workbookId() The ID of the workbook whose table rows are being queried.

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

overrideConfiguration

Methods inherited from class java.lang.Object

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 whose table rows are being queried.

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

Returns:

The ID of the workbook whose table rows are being queried.

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

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

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

filterFormula

public final Filter filterFormula()

An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.

Returns:

An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.

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 QueryTableRowsRequest.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<QueryTableRowsRequest.Builder,QueryTableRowsRequest>

Specified by:

toBuilder in class HoneycodeRequest

Returns:

a builder for type T

builder

public static QueryTableRowsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends QueryTableRowsRequest.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.