com.azure.data.tables

Class TableAsyncBatch

java.lang.Object

com.azure.data.tables.TableAsyncBatch

public final class TableAsyncBatch
extends Object

Provides a batch object for asynchronously executing a transaction containing one or more operations on entities within a table in the Azure Tables service. The batch object represents a collection of one or more create, update, upsert, and/or delete operations on entities that share the same partition key within the table. When the batch is executed, all of the operations will be performed as part of a single transaction. As a result, either all operations in the batch will succeed, or if a failure occurs, all operations in the batch will be rolled back. Each operation in a batch must operate on a distinct row key. Attempting to add multiple operations to a batch that share the same row key will cause an exception to be thrown. Instances of this object are obtained by calling the TableAsyncClient.createBatch(String) method on a TableAsyncClient object.

Method Summary

Modifier and Type	Method and Description
TableAsyncBatch	createEntity(TableEntity entity) Inserts an entity into the table.
TableAsyncBatch	deleteEntity(String rowKey) Deletes an entity from the table.
TableAsyncBatch	deleteEntity(String rowKey, String eTag) Deletes an entity from the table.
List<com.azure.data.tables.implementation.models.BatchOperation>	getOperations() Gets an immutable list containing all operations added to this batch.
Mono<List<BatchOperationResponse>>	submitTransaction() Executes all operations within The batch inside a transaction.
Mono<com.azure.core.http.rest.Response<List<BatchOperationResponse>>>	submitTransactionWithResponse() Executes all operations within The batch inside a transaction.
TableAsyncBatch	updateEntity(TableEntity entity) Updates an existing entity by merging the provided entity with the existing entity.
TableAsyncBatch	updateEntity(TableEntity entity, UpdateMode updateMode) Updates an existing entity using the specified update mode.
TableAsyncBatch	updateEntity(TableEntity entity, UpdateMode updateMode, boolean ifUnchanged) Updates an existing entity using the specified update mode.
TableAsyncBatch	upsertEntity(TableEntity entity) Inserts an entity into the table if it does not exist, or merges the entity with the existing entity otherwise.
TableAsyncBatch	upsertEntity(TableEntity entity, UpdateMode updateMode) Inserts an entity into the table if it does not exist, or updates the existing entity using the specified update mode otherwise.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createEntity

public TableAsyncBatch createEntity(TableEntity entity)

Inserts an entity into the table.

Parameters:

entity - The entity to insert.

Returns:

The updated TableAsyncBatch.

Throws:

IllegalArgumentException - if the entity's partition key does not match the partition key provided when creating this TableAsyncBatch object, if the entity's row key is null or empty, or if another operation with the same row key has already been added to the batch.

IllegalStateException - if this method is called after the batch has been submitted.

upsertEntity

public TableAsyncBatch upsertEntity(TableEntity entity)

Inserts an entity into the table if it does not exist, or merges the entity with the existing entity otherwise. If no entity exists within the table having the same partition key and row key as the provided entity, it will be inserted. Otherwise, the provided entity's properties will be merged into the existing entity.

Parameters:

entity - The entity to upsert.

Returns:

The updated TableAsyncBatch.

Throws:

IllegalArgumentException - if the entity's partition key does not match the partition key provided when creating this TableAsyncBatch object, if the entity's row key is null or empty, or if another operation with the same row key has already been added to the batch.

IllegalStateException - if this method is called after the batch has been submitted.

upsertEntity

public TableAsyncBatch upsertEntity(TableEntity entity,
                                    UpdateMode updateMode)

Inserts an entity into the table if it does not exist, or updates the existing entity using the specified update mode otherwise. If no entity exists within the table having the same partition key and row key as the provided entity, it will be inserted. Otherwise, the existing entity will be updated according to the specified update mode. When the update mode is 'MERGE', the provided entity's properties will be merged into the existing entity. When the update mode is 'REPLACE', the provided entity's properties will completely replace those in the existing entity.

Parameters:

entity - The entity to upsert.

updateMode - The type of update to perform if the entity already exits.

Returns:

The updated TableAsyncBatch.

Throws:

IllegalArgumentException - if the entity's partition key does not match the partition key provided when creating this TableAsyncBatch object, if the entity's row key is null or empty, or if another operation with the same row key has already been added to the batch.

IllegalStateException - if this method is called after the batch has been submitted.

updateEntity

public TableAsyncBatch updateEntity(TableEntity entity)

Updates an existing entity by merging the provided entity with the existing entity.

Parameters:

entity - The entity to update.

Returns:

The updated TableAsyncBatch.

Throws:

IllegalArgumentException - if the entity's partition key does not match the partition key provided when creating this TableAsyncBatch object, if the entity's row key is null or empty, or if another operation with the same row key has already been added to the batch.

IllegalStateException - if this method is called after the batch has been submitted.

updateEntity

public TableAsyncBatch updateEntity(TableEntity entity,
                                    UpdateMode updateMode)

Updates an existing entity using the specified update mode. When the update mode is 'MERGE', the provided entity's properties will be merged into the existing entity. When the update mode is 'REPLACE', the provided entity's properties will completely replace those in the existing entity.

Parameters:

entity - The entity to update.

updateMode - The type of update to perform.

Returns:

The updated TableAsyncBatch.

Throws:

IllegalArgumentException - if the entity's partition key does not match the partition key provided when creating this TableAsyncBatch object, if the entity's row key is null or empty, or if another operation with the same row key has already been added to the batch.

IllegalStateException - if this method is called after the batch has been submitted.

updateEntity

public TableAsyncBatch updateEntity(TableEntity entity,
                                    UpdateMode updateMode,
                                    boolean ifUnchanged)

Updates an existing entity using the specified update mode. When the update mode is 'MERGE', the provided entity's properties will be merged into the existing entity. When the update mode is 'REPLACE', the provided entity's properties will completely replace those in the existing entity.

Parameters:

entity - The entity to update.

updateMode - The type of update to perform.

ifUnchanged - When true, the eTag of the provided entity must match the eTag of the entity in the Table service. If the values do not match, the update will not occur and an exception will be thrown.

Returns:

The updated TableAsyncBatch.

Throws:

IllegalArgumentException - if the entity's partition key does not match the partition key provided when creating this TableAsyncBatch object, if the entity's row key is null or empty, or if another operation with the same row key has already been added to the batch.

IllegalStateException - if this method is called after the batch has been submitted.

deleteEntity

public TableAsyncBatch deleteEntity(String rowKey)

Deletes an entity from the table.

Parameters:

rowKey - The row key of the entity.

Returns:

The updated TableAsyncBatch.

Throws:

IllegalArgumentException - if the provided row key is null or empty, or if another operation with the same row key has already been added to the batch.

IllegalStateException - if this method is called after the batch has been submitted.

deleteEntity

public TableAsyncBatch deleteEntity(String rowKey,
                                    String eTag)

Deletes an entity from the table.

Parameters:

rowKey - The row key of the entity.

eTag - The value to compare with the eTag of the entity in the Tables service. If the values do not match, the delete will not occur and an exception will be thrown.

Returns:

The updated TableAsyncBatch.

Throws:

IllegalArgumentException - if the provided row key is null or empty, or if another operation with the same row key has already been added to the batch.

IllegalStateException - if this method is called after the batch has been submitted.

getOperations

public List<com.azure.data.tables.implementation.models.BatchOperation> getOperations()

Gets an immutable list containing all operations added to this batch.

Returns:

An immutable list containing all operations added to this batch.

submitTransaction

public Mono<List<BatchOperationResponse>> submitTransaction()

Executes all operations within The batch inside a transaction. When the call completes, either all operations in the batch will succeed, or if a failure occurs, all operations in the batch will be rolled back.

Returns:

A reactive result containing a list of sub-responses for each operation in the batch.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if any operation within the batch fails. See the documentation for the client methods in TableAsyncClient to understand the conditions that may cause a given operation to fail.

IllegalStateException - if no operations have been added to the batch.

submitTransactionWithResponse

public Mono<com.azure.core.http.rest.Response<List<BatchOperationResponse>>> submitTransactionWithResponse()

Executes all operations within The batch inside a transaction. When the call completes, either all operations in the batch will succeed, or if a failure occurs, all operations in the batch will be rolled back.

Returns:

A reactive result containing the HTTP response produced for the batch itself. The response's value will contain a list of sub-responses for each operation in the batch.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if any operation within the batch fails. See the documentation for the client methods in TableAsyncClient to understand the conditions that may cause a given operation to fail.

IllegalStateException - if no operations have been added to the batch.