Class: Aws::Honeycode::Types::QueryTableRowsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-honeycode/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter_formula ⇒ Types::Filter

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

Returns:



1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/aws-sdk-honeycode/types.rb', line 1211

class QueryTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :filter_formula,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

  • (Integer) 


1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/aws-sdk-honeycode/types.rb', line 1211

class QueryTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :filter_formula,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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:

  • (String) 


1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/aws-sdk-honeycode/types.rb', line 1211

class QueryTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :filter_formula,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#table_id ⇒ String

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:

  • (String) 


1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/aws-sdk-honeycode/types.rb', line 1211

class QueryTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :filter_formula,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#workbook_id ⇒ String

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:

  • (String) 


1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/aws-sdk-honeycode/types.rb', line 1211

class QueryTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :filter_formula,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end