Package software.amazon.awssdk.services.honeycode.model

Interface BatchUpdateTableRowsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<BatchUpdateTableRowsRequest.Builder,BatchUpdateTableRowsRequest>, HoneycodeRequest.Builder, SdkBuilder<BatchUpdateTableRowsRequest.Builder,BatchUpdateTableRowsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
BatchUpdateTableRowsRequest
public static interface BatchUpdateTableRowsRequest.Builder extends HoneycodeRequest.Builder, SdkPojo, CopyableBuilder<BatchUpdateTableRowsRequest.Builder,BatchUpdateTableRowsRequest>

  • Method Details

    • workbookId

      BatchUpdateTableRowsRequest.Builder workbookId(String workbookId)

      The ID of the workbook where the rows are being updated.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

      Parameters:
      workbookId - The ID of the workbook where the rows are being updated.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tableId

      BatchUpdateTableRowsRequest.Builder tableId(String tableId)

      The ID of the table where the rows are being updated.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

      Parameters:
      tableId - The ID of the table where the rows are being updated.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rowsToUpdate

      BatchUpdateTableRowsRequest.Builder rowsToUpdate(Collection<UpdateRowData> rowsToUpdate)

      The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

      Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.

      Parameters:
      rowsToUpdate - The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

      Note that if one of the row or column ids in the request does not exist in the table, then the 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.

    • rowsToUpdate

      BatchUpdateTableRowsRequest.Builder rowsToUpdate(UpdateRowData... rowsToUpdate)

      The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

      Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.

      Parameters:
      rowsToUpdate - The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

      Note that if one of the row or column ids in the request does not exist in the table, then the 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.

    • rowsToUpdate

      BatchUpdateTableRowsRequest.Builder rowsToUpdate(Consumer<UpdateRowData.Builder>... rowsToUpdate)

      The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

      Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.

      This is a convenience method that creates an instance of the UpdateRowData.Builder avoiding the need to create one manually via UpdateRowData.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rowsToUpdate(List<UpdateRowData>).

      Parameters:
      rowsToUpdate - a consumer that will call methods on UpdateRowData.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientRequestToken

      BatchUpdateTableRowsRequest.Builder clientRequestToken(String clientRequestToken)

      The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

      Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

      Parameters:
      clientRequestToken - The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

      Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      BatchUpdateTableRowsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      BatchUpdateTableRowsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.