Class BatchUpdateTableRowsRequest

    • Method Detail

      • workbookId

        public final 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.

        Returns:
        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.

      • tableId

        public final 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.

        Returns:
        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.

      • hasRowsToUpdate

        public final boolean hasRowsToUpdate()
        For responses, this returns true if the service returned a value for the RowsToUpdate property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • rowsToUpdate

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRowsToUpdate() method.

        Returns:
        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.

      • clientRequestToken

        public final 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.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object