libZSservicesZSamazonka-honeycodeZSamazonka-honeycode
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.HoneyCode.Types.UpsertRowData

Description

 
Synopsis

Documentation

data UpsertRowData Source #

Data needed to upsert rows in a table as part of a single item in the BatchUpsertTableRows request.

See: newUpsertRowData smart constructor.

Constructors

UpsertRowData' 

Fields

  • batchItemId :: Text

    An external identifier that represents a single item in the request that is being upserted as part of the BatchUpsertTableRows request. This can be any string that you can use to identify the item in the request. The BatchUpsertTableRows API puts the batch item id in the results to allow you to link data in the request to data in the results.

  • filter' :: Filter

    The filter formula to use to find existing matching rows to update. The formula needs to return zero or more rows. If the formula returns 0 rows, then a new row will be appended in the target table. If the formula returns one or more rows, then the returned rows will be updated.

    Note that the filter formula needs to return rows from the target table for the upsert operation to succeed. If the filter formula has a syntax error or it doesn't evaluate to zero or more rows in the target table for any one item in the input list, then the entire BatchUpsertTableRows request fails and no updates are made to the table.

  • cellsToUpdate :: HashMap Text CellInput

    A map representing the cells to update for the matching rows or an appended row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.

Instances

Instances details
Eq UpsertRowData Source # 
Instance details

Defined in Amazonka.HoneyCode.Types.UpsertRowData

Show UpsertRowData Source # 
Instance details

Defined in Amazonka.HoneyCode.Types.UpsertRowData

Generic UpsertRowData Source # 
Instance details

Defined in Amazonka.HoneyCode.Types.UpsertRowData

Associated Types

type Rep UpsertRowData :: Type -> Type #

NFData UpsertRowData Source # 
Instance details

Defined in Amazonka.HoneyCode.Types.UpsertRowData

Methods

rnf :: UpsertRowData -> () #

Hashable UpsertRowData Source # 
Instance details

Defined in Amazonka.HoneyCode.Types.UpsertRowData

ToJSON UpsertRowData Source # 
Instance details

Defined in Amazonka.HoneyCode.Types.UpsertRowData

type Rep UpsertRowData Source # 
Instance details

Defined in Amazonka.HoneyCode.Types.UpsertRowData

type Rep UpsertRowData = D1 ('MetaData "UpsertRowData" "Amazonka.HoneyCode.Types.UpsertRowData" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "UpsertRowData'" 'PrefixI 'True) (S1 ('MetaSel ('Just "batchItemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Filter) :*: S1 ('MetaSel ('Just "cellsToUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text CellInput)))))

newUpsertRowData Source #

Create a value of UpsertRowData 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:batchItemId:UpsertRowData', upsertRowData_batchItemId - An external identifier that represents a single item in the request that is being upserted as part of the BatchUpsertTableRows request. This can be any string that you can use to identify the item in the request. The BatchUpsertTableRows API puts the batch item id in the results to allow you to link data in the request to data in the results.

$sel:filter':UpsertRowData', upsertRowData_filter - The filter formula to use to find existing matching rows to update. The formula needs to return zero or more rows. If the formula returns 0 rows, then a new row will be appended in the target table. If the formula returns one or more rows, then the returned rows will be updated.

Note that the filter formula needs to return rows from the target table for the upsert operation to succeed. If the filter formula has a syntax error or it doesn't evaluate to zero or more rows in the target table for any one item in the input list, then the entire BatchUpsertTableRows request fails and no updates are made to the table.

$sel:cellsToUpdate:UpsertRowData', upsertRowData_cellsToUpdate - A map representing the cells to update for the matching rows or an appended row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.

upsertRowData_batchItemId :: Lens' UpsertRowData Text Source #

An external identifier that represents a single item in the request that is being upserted as part of the BatchUpsertTableRows request. This can be any string that you can use to identify the item in the request. The BatchUpsertTableRows API puts the batch item id in the results to allow you to link data in the request to data in the results.

upsertRowData_filter :: Lens' UpsertRowData Filter Source #

The filter formula to use to find existing matching rows to update. The formula needs to return zero or more rows. If the formula returns 0 rows, then a new row will be appended in the target table. If the formula returns one or more rows, then the returned rows will be updated.

Note that the filter formula needs to return rows from the target table for the upsert operation to succeed. If the filter formula has a syntax error or it doesn't evaluate to zero or more rows in the target table for any one item in the input list, then the entire BatchUpsertTableRows request fails and no updates are made to the table.

upsertRowData_cellsToUpdate :: Lens' UpsertRowData (HashMap Text CellInput) Source #

A map representing the cells to update for the matching rows or an appended row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.