Interface UpsertRowData.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<UpsertRowData.Builder,
,UpsertRowData> SdkBuilder<UpsertRowData.Builder,
,UpsertRowData> SdkPojo
- Enclosing class:
UpsertRowData
-
Method Summary
Modifier and TypeMethodDescriptionbatchItemId
(String batchItemId) An external identifier that represents a single item in the request that is being upserted as part of the BatchUpsertTableRows request.cellsToUpdate
(Map<String, CellInput> cellsToUpdate) A map representing the cells to update for the matching rows or an appended row.default UpsertRowData.Builder
filter
(Consumer<Filter.Builder> filter) The filter formula to use to find existing matching rows to update.The filter formula to use to find existing matching rows to update.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theFilter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilter(Filter)
.- Parameters:
filter
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-