Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.HoneyCode.Types.ResultSet

Description

Synopsis

data ResultSet = ResultSet' {
- headers :: [ColumnMetadata]
- rows :: [ResultRow]
}
newResultSet :: ResultSet
resultSet_headers :: Lens' ResultSet [ColumnMetadata]
resultSet_rows :: Lens' ResultSet [ResultRow]

Documentation

data ResultSet Source #

ResultSet contains the results of the request for a single block or list defined on the screen.

See: newResultSet smart constructor.

Constructors

ResultSet'

Fields

headers :: [ColumnMetadata]
List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.
For example, a task list that displays the task name, due date and assigned person might have headers [ { "name": "Task Name"}, {"name": "Due Date", "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.
rows :: [ResultRow]
List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.

Instances

Instances details

Eq ResultSet Source #
Instance details Defined in Amazonka.HoneyCode.Types.ResultSet Methods (==) :: ResultSet -> ResultSet -> Bool # (/=) :: ResultSet -> ResultSet -> Bool #
Show ResultSet Source #
Instance details Defined in Amazonka.HoneyCode.Types.ResultSet Methods showsPrec :: Int -> ResultSet -> ShowS # show :: ResultSet -> String # showList :: [ResultSet] -> ShowS #
Generic ResultSet Source #
Instance details Defined in Amazonka.HoneyCode.Types.ResultSet Associated Types type Rep ResultSet :: Type -> Type # Methods from :: ResultSet -> Rep ResultSet x # to :: Rep ResultSet x -> ResultSet #
NFData ResultSet Source #
Instance details Defined in Amazonka.HoneyCode.Types.ResultSet Methods rnf :: ResultSet -> () #
Hashable ResultSet Source #
Instance details Defined in Amazonka.HoneyCode.Types.ResultSet Methods hashWithSalt :: Int -> ResultSet -> Int # hash :: ResultSet -> Int #
FromJSON ResultSet Source #
Instance details Defined in Amazonka.HoneyCode.Types.ResultSet Methods parseJSON :: Value -> Parser ResultSet # parseJSONList :: Value -> Parser [ResultSet] #
type Rep ResultSet Source #
Instance details Defined in Amazonka.HoneyCode.Types.ResultSet type Rep ResultSet = D1 ('MetaData "ResultSet" "Amazonka.HoneyCode.Types.ResultSet" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "ResultSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ColumnMetadata]) :*: S1 ('MetaSel ('Just "rows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ResultRow])))

newResultSet :: ResultSet Source #

Create a value of ResultSet 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:headers:ResultSet', resultSet_headers - List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.

For example, a task list that displays the task name, due date and assigned person might have headers [ { "name": "Task Name"}, {"name": "Due Date", "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.

$sel:rows:ResultSet', resultSet_rows - List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.

resultSet_headers :: Lens' ResultSet [ColumnMetadata] Source #

List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.

For example, a task list that displays the task name, due date and assigned person might have headers [ { "name": "Task Name"}, {"name": "Due Date", "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.

resultSet_rows :: Lens' ResultSet [ResultRow] Source #

List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.