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

Interface QueryTableRowsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<QueryTableRowsRequest.Builder,QueryTableRowsRequest>, HoneycodeRequest.Builder, SdkBuilder<QueryTableRowsRequest.Builder,QueryTableRowsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
QueryTableRowsRequest
public static interface QueryTableRowsRequest.Builder extends HoneycodeRequest.Builder, SdkPojo, CopyableBuilder<QueryTableRowsRequest.Builder,QueryTableRowsRequest>

  • Method Details

    • workbookId

      QueryTableRowsRequest.Builder workbookId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • tableId

      QueryTableRowsRequest.Builder tableId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • filterFormula

      QueryTableRowsRequest.Builder filterFormula(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • filterFormula

      default QueryTableRowsRequest.Builder filterFormula(Consumer<Filter.Builder> filterFormula)

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

      This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filterFormula(Filter).

      Parameters:
      filterFormula - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      QueryTableRowsRequest.Builder maxResults(Integer maxResults)

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

      Parameters:
      maxResults - The maximum number of rows to return in each page of the results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      QueryTableRowsRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      QueryTableRowsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      QueryTableRowsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.