Class: Aws::Honeycode::Types::UpsertRowData

Inherits:

Struct

• Object
• Struct
• Aws::Honeycode::Types::UpsertRowData

Defined in:

gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #batch_item_id ⇒ String

  An external identifier that represents a single item in the request that is being upserted as part of the BatchUpsertTableRows request.

• #cells_to_update ⇒ Hash<String,Types::CellInput>

  A map representing the cells to update for the matching rows or an appended row.

• #filter ⇒ Types::Filter

  The filter formula to use to find existing matching rows to update.

Instance Attribute Details

#batch_item_id ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 1659

class UpsertRowData < Struct.new(
  :batch_item_id,
  :filter,
  :cells_to_update)
  SENSITIVE = []
  include Aws::Structure
end

#cells_to_update ⇒ Hash<String,Types::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.

Returns:

• (Hash<String,Types::CellInput>)

# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 1659

class UpsertRowData < Struct.new(
  :batch_item_id,
  :filter,
  :cells_to_update)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ Types::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.

Returns:

• (Types::Filter)

# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 1659

class UpsertRowData < Struct.new(
  :batch_item_id,
  :filter,
  :cells_to_update)
  SENSITIVE = []
  include Aws::Structure
end