Class: Aws::Honeycode::Types::Filter

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

Overview

Note:

When making an API call, you may pass Filter data as a hash:

{
  formula: "Formula", # required
  context_row_id: "RowId",
}

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

Constant Summary collapse

SENSITIVE =
[:formula]

Instance Attribute Summary collapse

Instance Attribute Details

#context_row_idString

The optional contextRowId attribute can be used to specify the row id of the context row if the filter formula contains unqualified references to table columns and needs a context row to evaluate them successfully.

Returns:

  • (String)


795
796
797
798
799
800
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 795

class Filter < Struct.new(
  :formula,
  :context_row_id)
  SENSITIVE = [:formula]
  include Aws::Structure
end

#formulaString

A formula representing a filter function that returns zero or more matching rows from a table. Valid formulas in this field return a list of rows from a table. The most common ways of writing a formula to return a list of rows are to use the FindRow() or Filter() functions. Any other formula that returns zero or more rows is also acceptable. For example, you can use a formula that points to a cell that contains a filter function.

Returns:

  • (String)


795
796
797
798
799
800
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 795

class Filter < Struct.new(
  :formula,
  :context_row_id)
  SENSITIVE = [:formula]
  include Aws::Structure
end