Interface BatchCreateTableRowsRequest.Builder

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

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

    • workbookId

      The ID of the workbook where the new rows are being added.

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

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

      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 new rows are being added.

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

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

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

      The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.

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

      Parameters:
      rowsToCreate - The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.

      Note that if one of the column ids in any of the rows 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.
    • rowsToCreate

      BatchCreateTableRowsRequest.Builder rowsToCreate(CreateRowData... rowsToCreate)

      The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.

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

      Parameters:
      rowsToCreate - The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.

      Note that if one of the column ids in any of the rows 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.
    • rowsToCreate

      The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.

      Note that if one of the column ids in any of the rows 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 CreateRowData.Builder avoiding the need to create one manually via CreateRowData.builder().

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

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

      BatchCreateTableRowsRequest.Builder clientRequestToken(String clientRequestToken)

      The request token for performing the batch create operation. 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 operation 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 batch create operation. 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 operation 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

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