Amazonka.HoneyCode.Types.Filter

Documentation

data Filter

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

See: newFilter smart constructor.

Constructors

Filter'

Fields

• contextRowId :: Maybe Text

  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.

• formula :: Sensitive Text

  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.

Instances

ToJSON Filter

Defined in Amazonka.HoneyCode.Types.Filter

Methods

toJSON :: Filter -> Value

toEncoding :: Filter -> Encoding

toJSONList :: [Filter] -> Value

toEncodingList :: [Filter] -> Encoding

Generic Filter

Defined in Amazonka.HoneyCode.Types.Filter

Associated Types

type Rep Filter :: Type -> Type

Methods

from :: Filter -> Rep Filter x

to :: Rep Filter x -> Filter

Show Filter

Defined in Amazonka.HoneyCode.Types.Filter

Methods

showsPrec :: Int -> Filter -> ShowS

show :: Filter -> String

showList :: [Filter] -> ShowS

NFData Filter

Defined in Amazonka.HoneyCode.Types.Filter

Methods

rnf :: Filter -> ()

Eq Filter

Defined in Amazonka.HoneyCode.Types.Filter

Methods

(==) :: Filter -> Filter -> Bool

(/=) :: Filter -> Filter -> Bool

Hashable Filter

Defined in Amazonka.HoneyCode.Types.Filter

Methods

hashWithSalt :: Int -> Filter -> Int

hash :: Filter -> Int

type Rep Filter

Defined in Amazonka.HoneyCode.Types.Filter

type Rep Filter = D1 ('MetaData "Filter" "Amazonka.HoneyCode.Types.Filter" "amazonka-honeycode-2.0-IdtoOmZm6eT6kjUDWwPe6X" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contextRowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "formula") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))

newFilter

Arguments

:: Text

$sel:formula:Filter'

-> Filter

Create a value of Filter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contextRowId:Filter', filter_contextRowId - 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.

$sel:formula:Filter', filter_formula - 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.

filter_contextRowId :: Lens' Filter (Maybe Text)

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.

filter_formula :: Lens' Filter Text

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.