com.microsoft.azure.storage.table

Class TableOperation

java.lang.Object

com.microsoft.azure.storage.table.TableOperation

Direct Known Subclasses:

QueryTableOperation

public class TableOperation
extends Object

A class which represents a single table operation.

Use the static factory methods to construct TableOperation instances for operations on tables that insert, update, merge, delete, replace or retrieve table entities. To execute a TableOperation instance, call the execute method on a CloudTableClient instance. A TableOperation may be executed directly or as part of a TableBatchOperation. If a TableOperation returns an entity result, it is stored in the corresponding TableResult returned by the execute method.

Method Summary

Methods

Modifier and Type	Method and Description
static TableOperation	delete(TableEntity entity) A static factory method returning a TableOperation instance to delete the specified entity from Microsoft Azure storage.
static TableOperation	insert(TableEntity entity) A static factory method returning a TableOperation instance to insert the specified entity into Microsoft Azure storage.
static TableOperation	insert(TableEntity entity, boolean echoContent) A static factory method returning a TableOperation instance to insert the specified entity into Microsoft Azure storage.
static TableOperation	insertOrMerge(TableEntity entity) A static factory method returning a TableOperation instance to merge the specified entity into Microsoft Azure storage, or insert it if it does not exist.
static TableOperation	insertOrReplace(TableEntity entity) A static factory method returning a TableOperation instance to replace the specified entity in Microsoft Azure storage, or insert it if it does not exist.
static TableOperation	merge(TableEntity entity) A static factory method returning a TableOperation instance to merge the specified table entity into Microsoft Azure storage.
static TableOperation	replace(TableEntity entity) A static factory method returning a TableOperation instance to replace the specified table entity.
static TableOperation	retrieve(String partitionKey, String rowKey, Class<? extends TableEntity> clazzType) A static factory method returning a TableOperation instance to retrieve the specified table entity and return it as the specified type.
static TableOperation	retrieve(String partitionKey, String rowKey, EntityResolver<?> resolver) A static factory method returning a TableOperation instance to retrieve the specified table entity and return a projection of it using the specified resolver.

Methods inherited from class java.lang.Object

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

Method Detail

delete

public static TableOperation delete(TableEntity entity)

A static factory method returning a TableOperation instance to delete the specified entity from Microsoft Azure storage. To execute this TableOperation on a given table, call the CloudTable.execute(TableOperation) method on a CloudTableClient instance with the

Parameters:

entity - The object instance implementing TableEntity to associate with the operation.

Returns:

A new TableOperation instance to insert the table entity.

insert

public static TableOperation insert(TableEntity entity)

A static factory method returning a TableOperation instance to insert the specified entity into Microsoft Azure storage. To execute this TableOperation on a given table, call the CloudTable.execute(TableOperation) method on a CloudTableClient instance with the

Parameters:

entity - The object instance implementing TableEntity to associate with the operation.

Returns:

A new TableOperation instance to insert the table entity.

insert

public static TableOperation insert(TableEntity entity,
                    boolean echoContent)

A static factory method returning a TableOperation instance to insert the specified entity into Microsoft Azure storage. To execute this TableOperation on a given table, call the CloudTable.execute(TableOperation) method on a CloudTableClient instance with the

Parameters:

entity - The object instance implementing TableEntity to associate with the operation.

echoContent - The boolean representing whether the message payload should be returned in the response.

Returns:

A new TableOperation instance to insert the table entity.

insertOrMerge

public static TableOperation insertOrMerge(TableEntity entity)

A static factory method returning a TableOperation instance to merge the specified entity into Microsoft Azure storage, or insert it if it does not exist. To execute this TableOperation on a given table, call the CloudTable.execute(TableOperation) method on a CloudTableClient instance with the table name and the TableOperation as arguments.

Parameters:

entity - The object instance implementing TableEntity to associate with the operation.

Returns:

A new TableOperation instance for inserting or merging the table entity.

insertOrReplace

public static TableOperation insertOrReplace(TableEntity entity)

A static factory method returning a TableOperation instance to replace the specified entity in Microsoft Azure storage, or insert it if it does not exist. To execute this TableOperation on a given table, call the CloudTable.execute(TableOperation) method on a CloudTableClient instance with the table name and the TableOperation as arguments.

Parameters:

entity - The object instance implementing TableEntity to associate with the operation.

Returns:

A new TableOperation instance for inserting or replacing the table entity.

merge

public static TableOperation merge(TableEntity entity)

A static factory method returning a TableOperation instance to merge the specified table entity into Microsoft Azure storage. To execute this TableOperation on a given table, call the CloudTable.execute(TableOperation) method on a CloudTableClient instance with the

Parameters:

entity - The object instance implementing TableEntity to associate with the operation.

Returns:

A new TableOperation instance for merging the table entity.

retrieve

public static TableOperation retrieve(String partitionKey,
                      String rowKey,
                      Class<? extends TableEntity> clazzType)

A static factory method returning a TableOperation instance to retrieve the specified table entity and return it as the specified type. To execute this TableOperation on a given table, call the CloudTable.execute(TableOperation) method on a CloudTableClient instance with the

Parameters:

partitionKey - A String which specifies the PartitionKey value for the entity to retrieve.

rowKey - A String which specifies the RowKey value for the entity to retrieve.

clazzType - The class type of the table entity object to retrieve.

Returns:

A new TableOperation instance for retrieving the table entity.

retrieve

public static TableOperation retrieve(String partitionKey,
                      String rowKey,
                      EntityResolver<?> resolver)

A static factory method returning a TableOperation instance to retrieve the specified table entity and return a projection of it using the specified resolver. To execute this TableOperation on a given table, call the CloudTable.execute(TableOperation) method on a CloudTableClient instance with the table name and the TableOperation as arguments.

Parameters:

partitionKey - A String which specifies the PartitionKey value for the entity to retrieve.

rowKey - A String which specifies the RowKey value for the entity to retrieve.

resolver - The implementation of EntityResolver to use to project the result entity as type T.

Returns:

A new TableOperation instance for retrieving the table entity.

replace

public static TableOperation replace(TableEntity entity)

A static factory method returning a TableOperation instance to replace the specified table entity. To execute this TableOperation on a given table, call the CloudTable.execute(TableOperation) method.

Parameters:

entity - The object instance implementing TableEntity to associate with the operation.

Returns:

A new TableOperation instance for replacing the table entity.