com.azure.data.tables

Class TableClient

java.lang.Object

com.azure.data.tables.TableClient

public class TableClient
extends Object

Provides a synchronous service client for accessing a table in the Azure Tables service. The client encapsulates the URL for the table within the Tables service endpoint, the name of the table, and the credentials for accessing the storage or CosmosDB table API account. It provides methods to create and delete the table itself, as well as methods to create, upsert, update, delete, list, and get entities within the table. These methods invoke REST API operations to make the requests and obtain the results that are returned. Instances of this client are obtained by calling the TableClientBuilder.buildClient() method on a TableClientBuilder object.

Method Summary

Modifier and Type	Method and Description
void	create() Creates the table within the Tables service.
void	create(Duration timeout) Creates the table within the Tables service.
TableBatch	createBatch(String partitionKey) Creates a new TableBatch object.
void	createEntity(TableEntity entity) Inserts an entity into the table.
void	createEntity(TableEntity entity, Duration timeout) Inserts an entity into the table.
com.azure.core.http.rest.Response<Void>	createEntityWithResponse(TableEntity entity, Duration timeout, com.azure.core.util.Context context) Inserts an entity into the table.
com.azure.core.http.rest.Response<Void>	createWithResponse(Duration timeout, com.azure.core.util.Context context) Creates the table within the Tables service.
void	delete() Deletes the table within the Tables service.
void	delete(Duration timeout) Deletes the table within the Tables service.
void	deleteEntity(String partitionKey, String rowKey) Deletes an entity from the table.
void	deleteEntity(String partitionKey, String rowKey, String eTag) Deletes an entity from the table.
void	deleteEntity(String partitionKey, String rowKey, String eTag, Duration timeout) Deletes an entity from the table.
com.azure.core.http.rest.Response<Void>	deleteEntityWithResponse(String partitionKey, String rowKey, String eTag, Duration timeout, com.azure.core.util.Context context) Deletes an entity from the table.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(Duration timeout, com.azure.core.util.Context context) Deletes the table within the Tables service.
String	getAccountName() Gets the name of the account containing the table.
TablesServiceVersion	getApiVersion() Gets the REST API version used by this client.
TableEntity	getEntity(String partitionKey, String rowKey) Gets a single entity from the table.
<T extends TableEntity> T	getEntity(String partitionKey, String rowKey, Class<T> resultType) Gets a single entity from the table.
TableEntity	getEntity(String partitionKey, String rowKey, String select) Gets a single entity from the table.
<T extends TableEntity> T	getEntity(String partitionKey, String rowKey, String select, Class<T> resultType) Gets a single entity from the table.
<T extends TableEntity> T	getEntity(String partitionKey, String rowKey, String select, Class<T> resultType, Duration timeout) Gets a single entity from the table.
TableEntity	getEntity(String partitionKey, String rowKey, String select, Duration timeout) Gets a single entity from the table.
<T extends TableEntity> com.azure.core.http.rest.Response<T>	getEntityWithResponse(String partitionKey, String rowKey, String select, Class<T> resultType, Duration timeout, com.azure.core.util.Context context) Gets a single entity from the table.
com.azure.core.http.rest.Response<TableEntity>	getEntityWithResponse(String partitionKey, String rowKey, String select, Duration timeout, com.azure.core.util.Context context) Gets a single entity from the table.
String	getTableName() Gets the name of the table.
String	getTableUrl() Gets the absolute URL for this table.
com.azure.core.http.rest.PagedIterable<TableEntity>	listEntities() Lists all entities within the table.
<T extends TableEntity> com.azure.core.http.rest.PagedIterable<T>	listEntities(Class<T> resultType) Lists all entities within the table.
com.azure.core.http.rest.PagedIterable<TableEntity>	listEntities(ListEntitiesOptions options) Lists entities using the parameters in the provided options.
<T extends TableEntity> com.azure.core.http.rest.PagedIterable<T>	listEntities(ListEntitiesOptions options, Class<T> resultType) Lists entities using the parameters in the provided options.
void	updateEntity(TableEntity entity) Updates an existing entity by merging the provided entity with the existing entity.
void	updateEntity(TableEntity entity, UpdateMode updateMode) Updates an existing entity using the specified update mode.
void	updateEntity(TableEntity entity, UpdateMode updateMode, boolean ifUnchanged) Updates an existing entity using the specified update mode.
void	updateEntity(TableEntity entity, UpdateMode updateMode, boolean ifUnchanged, Duration timeout) Updates an existing entity using the specified update mode.
com.azure.core.http.rest.Response<Void>	updateEntityWithResponse(TableEntity entity, UpdateMode updateMode, boolean ifUnchanged, Duration timeout, com.azure.core.util.Context context) Updates an existing entity using the specified update mode.
void	upsertEntity(TableEntity entity) Inserts an entity into the table if it does not exist, or merges the entity with the existing entity otherwise.
void	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.
void	upsertEntity(TableEntity entity, UpdateMode updateMode, Duration timeout) Inserts an entity into the table if it does not exist, or updates the existing entity using the specified update mode otherwise.
com.azure.core.http.rest.Response<Void>	upsertEntityWithResponse(TableEntity entity, UpdateMode updateMode, Duration timeout, com.azure.core.util.Context context) 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

getTableName

public String getTableName()

Gets the name of the table.

Returns:

The name of the table.

getAccountName

public String getAccountName()

Gets the name of the account containing the table.

Returns:

The name of the account containing the table.

getTableUrl

public String getTableUrl()

Gets the absolute URL for this table.

Returns:

The absolute URL for this table.

getApiVersion

public TablesServiceVersion getApiVersion()

Gets the REST API version used by this client.

Returns:

The REST API version used by this client.

createBatch

public TableBatch createBatch(String partitionKey)

Creates a new TableBatch object. Batch objects allow you to enqueue multiple create, update, upsert, and/or delete operations on entities that share the same partition key. 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.

Parameters:

partitionKey - The partition key shared by all operations in the batch.

Returns:

An object representing the batch, to which operations can be added.

Throws:

IllegalArgumentException - if the provided partition key is null or empty.

create

public void create()

Creates the table within the Tables service.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if a table with the same name already exists within the service.

create

public void create(Duration timeout)

Creates the table within the Tables service.

Parameters:

timeout - Duration to wait for the operation to complete.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if a table with the same name already exists within the service.

RuntimeException - if the provided timeout expires.

createWithResponse

public com.azure.core.http.rest.Response<Void> createWithResponse(Duration timeout,
                                                                  com.azure.core.util.Context context)

Creates the table within the Tables service.

Parameters:

timeout - Duration to wait for the operation to complete.

context - Additional context that is passed through the HTTP pipeline during the service call.

Returns:

The HTTP response.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if a table with the same name already exists within the service.

RuntimeException - if the provided timeout expires.

createEntity

public void createEntity(TableEntity entity)

Inserts an entity into the table.

Parameters:

entity - The entity to insert.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if an entity with the same partition key and row key already exists within the table.

IllegalArgumentException - if the provided entity is invalid.

createEntity

public void createEntity(TableEntity entity,
                         Duration timeout)

Inserts an entity into the table.

Parameters:

entity - The entity to insert.

timeout - Duration to wait for the operation to complete.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if an entity with the same partition key and row key already exists within the table, or if the provided timeout expires.

IllegalArgumentException - if the provided entity is invalid.

createEntityWithResponse

public com.azure.core.http.rest.Response<Void> createEntityWithResponse(TableEntity entity,
                                                                        Duration timeout,
                                                                        com.azure.core.util.Context context)

Inserts an entity into the table.

Parameters:

entity - The entity to insert.

timeout - Duration to wait for the operation to complete.

context - Additional context that is passed through the HTTP pipeline during the service call.

Returns:

The HTTP response.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if an entity with the same partition key and row key already exists within the table, or if the provided timeout expires.

IllegalArgumentException - if the provided entity is invalid.

upsertEntity

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

Throws:

IllegalArgumentException - if the provided entity is invalid.

upsertEntity

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

Throws:

IllegalArgumentException - if the provided entity is invalid.

upsertEntity

public void upsertEntity(TableEntity entity,
                         UpdateMode updateMode,
                         Duration timeout)

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.

timeout - Duration to wait for the operation to complete.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if the provided timeout expires.

IllegalArgumentException - if the provided entity is invalid.

upsertEntityWithResponse

public com.azure.core.http.rest.Response<Void> upsertEntityWithResponse(TableEntity entity,
                                                                        UpdateMode updateMode,
                                                                        Duration timeout,
                                                                        com.azure.core.util.Context context)

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.

timeout - Duration to wait for the operation to complete.

context - Additional context that is passed through the HTTP pipeline during the service call.

Returns:

The HTTP response.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if the provided timeout expires.

IllegalArgumentException - if the provided entity is invalid.

updateEntity

public void updateEntity(TableEntity entity)

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

Parameters:

entity - The entity to update.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the same partition key and row key exists within the table.

IllegalArgumentException - if the provided entity is invalid.

updateEntity

public void 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 - which type of mode to execute

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the same partition key and row key exists within the table.

IllegalArgumentException - if the provided entity is invalid.

updateEntity

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

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the same partition key and row key exists within the table, or if ifUnchanged is true and the existing entity's eTag does not match that of the provided entity.

IllegalArgumentException - if the provided entity is invalid.

updateEntity

public void updateEntity(TableEntity entity,
                         UpdateMode updateMode,
                         boolean ifUnchanged,
                         Duration timeout)

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.

timeout - Duration to wait for the operation to complete.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the same partition key and row key exists within the table, or if ifUnchanged is true and the existing entity's eTag does not match that of the provided entity, or if the provided timeout expires.

IllegalArgumentException - if the provided entity is invalid.

updateEntityWithResponse

public com.azure.core.http.rest.Response<Void> updateEntityWithResponse(TableEntity entity,
                                                                        UpdateMode updateMode,
                                                                        boolean ifUnchanged,
                                                                        Duration timeout,
                                                                        com.azure.core.util.Context context)

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.

timeout - Duration to wait for the operation to complete.

context - Additional context that is passed through the HTTP pipeline during the service call.

Returns:

The HTTP response.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the same partition key and row key exists within the table, or if ifUnchanged is true and the existing entity's eTag does not match that of the provided entity, or if the provided timeout expires.

IllegalArgumentException - if the provided entity is invalid.

delete

public void delete()

Deletes the table within the Tables service.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no table with this name exists within the service.

delete

public void delete(Duration timeout)

Deletes the table within the Tables service.

Parameters:

timeout - Duration to wait for the operation to complete.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no table with this name exists within the service.

RuntimeException - if the provided timeout expires.

deleteWithResponse

public com.azure.core.http.rest.Response<Void> deleteWithResponse(Duration timeout,
                                                                  com.azure.core.util.Context context)

Deletes the table within the Tables service.

Parameters:

timeout - Duration to wait for the operation to complete.

context - Additional context that is passed through the HTTP pipeline during the service call.

Returns:

The HTTP response.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no table with this name exists within the service.

RuntimeException - if the provided timeout expires.

deleteEntity

public void deleteEntity(String partitionKey,
                         String rowKey)

Deletes an entity from the table.

Parameters:

partitionKey - The partition key of the entity.

rowKey - The row key of the entity.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table.

IllegalArgumentException - if the provided partition key or row key are null or empty.

deleteEntity

public void deleteEntity(String partitionKey,
                         String rowKey,
                         String eTag)

Deletes an entity from the table.

Parameters:

partitionKey - The partition key of the entity.

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.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table, or if eTag is not null and the existing entity's eTag does not match that of the provided entity.

IllegalArgumentException - if the provided partition key or row key are null or empty.

deleteEntity

public void deleteEntity(String partitionKey,
                         String rowKey,
                         String eTag,
                         Duration timeout)

Deletes an entity from the table.

Parameters:

partitionKey - The partition key of the entity.

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.

timeout - Duration to wait for the operation to complete.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table, or if eTag is not null and the existing entity's eTag does not match that of the provided entity, or if the provided timeout expires.

IllegalArgumentException - if the provided partition key or row key are null or empty.

deleteEntityWithResponse

public com.azure.core.http.rest.Response<Void> deleteEntityWithResponse(String partitionKey,
                                                                        String rowKey,
                                                                        String eTag,
                                                                        Duration timeout,
                                                                        com.azure.core.util.Context context)

Deletes an entity from the table.

Parameters:

partitionKey - The partition key of the entity.

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.

timeout - Duration to wait for the operation to complete.

context - Additional context that is passed through the HTTP pipeline during the service call.

Returns:

The HTTP response.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table, or if eTag is not null and the existing entity's eTag does not match that of the provided entity, or if the provided timeout expires.

IllegalArgumentException - if the provided partition key or row key are null or empty.

listEntities

public com.azure.core.http.rest.PagedIterable<TableEntity> listEntities()

Lists all entities within the table.

Returns:

A paged iterable containing all entities within the table.

listEntities

public com.azure.core.http.rest.PagedIterable<TableEntity> listEntities(ListEntitiesOptions options)

Lists entities using the parameters in the provided options. If the `filter` parameter in the options is set, only entities matching the filter will be returned. If the `select` parameter is set, only the properties included in the select parameter will be returned for each entity. If the `top` parameter is set, the number of returned entities will be limited to that value.

Parameters:

options - The `filter`, `select`, and `top` OData query options to apply to this operation.

Returns:

A paged iterable containing matching entities within the table.

Throws:

IllegalArgumentException - if one or more of the OData query options in options is malformed.

listEntities

public <T extends TableEntity> com.azure.core.http.rest.PagedIterable<T> listEntities(Class<T> resultType)

Lists all entities within the table.

Type Parameters:

T - The type of the result value, which must be a subclass of TableEntity.

Parameters:

resultType - The type of the result value, which must be a subclass of TableEntity.

Returns:

A paged iterable containing all entities within the table.

Throws:

IllegalArgumentException - if an instance of the provided resultType can't be created.

listEntities

public <T extends TableEntity> com.azure.core.http.rest.PagedIterable<T> listEntities(ListEntitiesOptions options,
                                                                                      Class<T> resultType)

Lists entities using the parameters in the provided options. If the `filter` parameter in the options is set, only entities matching the filter will be returned. If the `select` parameter is set, only the properties included in the select parameter will be returned for each entity. If the `top` parameter is set, the number of returned entities will be limited to that value.

Type Parameters:

T - The type of the result value, which must be a subclass of TableEntity.

Parameters:

options - The `filter`, `select`, and `top` OData query options to apply to this operation.

resultType - The type of the result value, which must be a subclass of TableEntity.

Returns:

A paged iterable containing matching entities within the table.

Throws:

IllegalArgumentException - if one or more of the OData query options in options is malformed, or if an instance of the provided resultType can't be created.

getEntity

public TableEntity getEntity(String partitionKey,
                             String rowKey)

Gets a single entity from the table.

Parameters:

partitionKey - The partition key of the entity.

rowKey - The partition key of the entity.

Returns:

The entity.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table.

IllegalArgumentException - if the provided partition key or row key are null or empty.

getEntity

public TableEntity getEntity(String partitionKey,
                             String rowKey,
                             String select)

Gets a single entity from the table.

Parameters:

partitionKey - The partition key of the entity.

rowKey - The partition key of the entity.

select - An OData `select` expression to limit the set of properties included in the returned entity.

Returns:

The entity.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table.

IllegalArgumentException - if the provided partition key or row key are null or empty, or if the select OData query option is malformed.

getEntity

public <T extends TableEntity> T getEntity(String partitionKey,
                                           String rowKey,
                                           Class<T> resultType)

Gets a single entity from the table.

Type Parameters:

T - The type of the result value, which must be a subclass of TableEntity.

Parameters:

partitionKey - The partition key of the entity.

rowKey - The partition key of the entity.

resultType - The type of the result value, which must be a subclass of TableEntity.

Returns:

The entity.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table.

IllegalArgumentException - if the provided partition key or row key are null or empty, or if an instance of the provided resultType can't be created.

getEntity

public <T extends TableEntity> T getEntity(String partitionKey,
                                           String rowKey,
                                           String select,
                                           Class<T> resultType)

Gets a single entity from the table.

Type Parameters:

T - The type of the result value, which must be a subclass of TableEntity.

Parameters:

partitionKey - The partition key of the entity.

rowKey - The partition key of the entity.

select - An OData `select` expression to limit the set of properties included in the returned entity.

resultType - The type of the result value, which must be a subclass of TableEntity.

Returns:

The entity.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table.

IllegalArgumentException - if the provided partition key or row key are null or empty, if the select OData query option is malformed, or if an instance of the provided resultType can't be created.

getEntity

public TableEntity getEntity(String partitionKey,
                             String rowKey,
                             String select,
                             Duration timeout)

Gets a single entity from the table.

Parameters:

partitionKey - The partition key of the entity.

rowKey - The partition key of the entity.

select - An OData `select` expression to limit the set of properties included in the returned entity.

timeout - Duration to wait for the operation to complete.

Returns:

The entity.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table, or if the provided timeout expires.

IllegalArgumentException - if the provided partition key or row key are null or empty, or if the select OData query option is malformed.

getEntity

public <T extends TableEntity> T getEntity(String partitionKey,
                                           String rowKey,
                                           String select,
                                           Class<T> resultType,
                                           Duration timeout)

Gets a single entity from the table.

Type Parameters:

T - The type of the result value, which must be a subclass of TableEntity.

Parameters:

partitionKey - The partition key of the entity.

rowKey - The partition key of the entity.

select - An OData `select` expression to limit the set of properties included in the returned entity.

resultType - The type of the result value, which must be a subclass of TableEntity.

timeout - Duration to wait for the operation to complete.

Returns:

The entity.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table, or if the provided timeout expires.

IllegalArgumentException - if the provided partition key or row key are null or empty, if the select OData query option is malformed, or if an instance of the provided resultType can't be created.

getEntityWithResponse

public com.azure.core.http.rest.Response<TableEntity> getEntityWithResponse(String partitionKey,
                                                                            String rowKey,
                                                                            String select,
                                                                            Duration timeout,
                                                                            com.azure.core.util.Context context)

Gets a single entity from the table.

Parameters:

partitionKey - The partition key of the entity.

rowKey - The partition key of the entity.

select - An OData `select` expression to limit the set of properties included in the returned entity.

timeout - Duration to wait for the operation to complete.

context - Additional context that is passed through the HTTP pipeline during the service call.

Returns:

The HTTP response containing the entity.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table, or if the provided timeout expires.

IllegalArgumentException - if the provided partition key or row key are null or empty, or if the select OData query option is malformed.

getEntityWithResponse

public <T extends TableEntity> com.azure.core.http.rest.Response<T> getEntityWithResponse(String partitionKey,
                                                                                          String rowKey,
                                                                                          String select,
                                                                                          Class<T> resultType,
                                                                                          Duration timeout,
                                                                                          com.azure.core.util.Context context)

Gets a single entity from the table.

Type Parameters:

T - The type of the result value, which must be a subclass of TableEntity.

Parameters:

partitionKey - The partition key of the entity.

rowKey - The partition key of the entity.

select - An OData `select` expression to limit the set of properties included in the returned entity.

resultType - The type of the result value, which must be a subclass of TableEntity.

timeout - Duration to wait for the operation to complete.

context - Additional context that is passed through the HTTP pipeline during the service call.

Returns:

The HTTP response containing the entity.

Throws:

com.azure.data.tables.implementation.models.TableServiceErrorException - if no entity with the provided partition key and row key exists within the table, or if the provided timeout expires.

IllegalArgumentException - if the provided partition key or row key are null or empty, if the select OData query option is malformed, or if an instance of the provided resultType can't be created.