Interface BatchUpsertTableRowsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<BatchUpsertTableRowsRequest.Builder,BatchUpsertTableRowsRequest>, HoneycodeRequest.Builder, SdkBuilder<BatchUpsertTableRowsRequest.Builder,BatchUpsertTableRowsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
BatchUpsertTableRowsRequest

public static interface BatchUpsertTableRowsRequest.Builder extends HoneycodeRequest.Builder, SdkPojo, CopyableBuilder<BatchUpsertTableRowsRequest.Builder,BatchUpsertTableRowsRequest>
  • Method Details

    • workbookId

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

      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 upserted.

      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

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

      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 upserted.

      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.
    • rowsToUpsert

      The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.

      Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows does not exist in the table, then the request fails and no updates are made to the table.

      Parameters:
      rowsToUpsert - The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.

      Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows 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.
    • rowsToUpsert

      BatchUpsertTableRowsRequest.Builder rowsToUpsert(UpsertRowData... rowsToUpsert)

      The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.

      Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows does not exist in the table, then the request fails and no updates are made to the table.

      Parameters:
      rowsToUpsert - The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.

      Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows 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.
    • rowsToUpsert

      The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.

      Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows 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 UpsertRowData.Builder avoiding the need to create one manually via UpsertRowData.builder().

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

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

      BatchUpsertTableRowsRequest.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

      BatchUpsertTableRowsRequest.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

      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.