com.azure.data.tables

Class TableClient

java.lang.Object

com.azure.data.tables.TableClient

public class TableClient
extends Object

sync client for table operations

Method Summary

Modifier and Type	Method and Description
void	create() creates new table with the name of this client
void	create(Duration timeout) creates new table with the name of this client
void	createEntity(TableEntity tableEntity) insert a TableEntity with the given properties and return that TableEntity.
void	createEntity(TableEntity tableEntity, Duration timeout) insert a TableEntity with the given properties and return that TableEntity.
com.azure.core.http.rest.Response<Void>	createEntityWithResponse(TableEntity tableEntity, Duration timeout, com.azure.core.util.Context context) insert a TableEntity with the given properties and return that TableEntity.
com.azure.core.http.rest.Response<Void>	createWithResponse(Duration timeout, com.azure.core.util.Context context) creates a new table with the name of this client
void	delete() deletes the table with the name of this client
void	delete(Duration timeout) deletes the table with the name of this client
void	deleteEntity(String partitionKey, String rowKey) deletes the entity with the given partition key and row key
void	deleteEntity(String partitionKey, String rowKey, String eTag) deletes the entity with the given partition key and row key
void	deleteEntity(String partitionKey, String rowKey, String eTag, Duration timeout) deletes the given entity
com.azure.core.http.rest.Response<Void>	deleteEntityWithResponse(String partitionKey, String rowKey, String eTag, Duration timeout, com.azure.core.util.Context context) deletes the given entity
com.azure.core.http.rest.Response<Void>	deleteWithResponse(Duration timeout, com.azure.core.util.Context context) deletes the table with the name of this client
String	getAccountName() returns the account for this table
TablesServiceVersion	getApiVersion() returns the version
TableEntity	getEntity(String partitionKey, String rowKey) gets the entity which fits the given criteria
com.azure.core.http.rest.Response<TableEntity>	getEntityWithResponse(String partitionKey, String rowKey, com.azure.core.util.Context context) gets the entity which fits the given criteria
String	getTableName() returns the table name associated with the client*
String	getTableUrl() returns Url of this table
com.azure.core.http.rest.PagedIterable<TableEntity>	listEntities() Queries and returns all entities in the given table
com.azure.core.http.rest.PagedIterable<TableEntity>	listEntities(ListEntitiesOptions options) Queries and returns entities in the given table using the odata QueryOptions
com.azure.core.http.rest.PagedIterable<TableEntity>	listEntities(ListEntitiesOptions options, Duration timeout) Queries and returns entities in the given table using the odata QueryOptions
void	updateEntity(TableEntity entity) if UpdateMode is MERGE, merges or fails if the entity doesn't exist.
void	updateEntity(TableEntity entity, boolean ifUnchanged, UpdateMode updateMode) if UpdateMode is MERGE, merges or fails if the entity doesn't exist.
void	updateEntity(TableEntity entity, boolean ifUnchanged, UpdateMode updateMode, Duration timeout) if UpdateMode is MERGE, merges or fails if the entity doesn't exist.
void	updateEntity(TableEntity entity, UpdateMode updateMode) if UpdateMode is MERGE, merges or fails if the entity doesn't exist.
com.azure.core.http.rest.Response<Void>	updateEntityWithResponse(TableEntity entity, boolean ifUnchanged, UpdateMode updateMode, Duration timeout, com.azure.core.util.Context context) if UpdateMode is MERGE, merges or fails if the entity doesn't exist.
void	upsertEntity(TableEntity entity) based on Mode it either inserts or merges if exists or inserts or merges if exists
void	upsertEntity(TableEntity entity, UpdateMode updateMode) based on Mode it either inserts or merges if exists or inserts or merges if exists
void	upsertEntity(TableEntity entity, UpdateMode updateMode, Duration timeout) based on Mode it either inserts or merges if exists or inserts or merges if exists
com.azure.core.http.rest.Response<Void>	upsertEntityWithResponse(TableEntity entity, UpdateMode updateMode, Duration timeout, com.azure.core.util.Context context) based on Mode it either inserts or merges if exists or inserts or merges if exists

Methods inherited from class java.lang.Object

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

Method Detail

getTableName

public String getTableName()

returns the table name associated with the client*

Returns:

table name

getAccountName

public String getAccountName()

returns the account for this table

Returns:

a string of the account name

getTableUrl

public String getTableUrl()

returns Url of this table

Returns:

Url

getApiVersion

public TablesServiceVersion getApiVersion()

returns the version

Returns:

the version

create

public void create()

creates new table with the name of this client

create

public void create(Duration timeout)

creates new table with the name of this client

Parameters:

timeout - Duration to wait for operation to complete.

createWithResponse

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

creates a new table with the name of this client

Parameters:

timeout - Duration to wait for operation to complete.

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

Returns:

The HTTP response.

createEntity

public void createEntity(TableEntity tableEntity)

insert a TableEntity with the given properties and return that TableEntity. Property map must include rowKey and partitionKey

Parameters:

tableEntity - the entity to add

createEntity

public void createEntity(TableEntity tableEntity,
                         Duration timeout)

insert a TableEntity with the given properties and return that TableEntity. Property map must include rowKey and partitionKey

Parameters:

tableEntity - the entity to add

timeout - max time for query to execute before erroring out

createEntityWithResponse

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

insert a TableEntity with the given properties and return that TableEntity. Property map must include rowKey and partitionKey

Parameters:

tableEntity - the entity to add

timeout - max time for query to execute before erroring out

context - the context of the query

Returns:

a response

upsertEntity

public void upsertEntity(TableEntity entity)

based on Mode it either inserts or merges if exists or inserts or merges if exists

Parameters:

entity - entity to upsert

upsertEntity

public void upsertEntity(TableEntity entity,
                         UpdateMode updateMode)

based on Mode it either inserts or merges if exists or inserts or merges if exists

Parameters:

updateMode - type of upsert

entity - entity to upsert

upsertEntity

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

based on Mode it either inserts or merges if exists or inserts or merges if exists

Parameters:

updateMode - type of upsert

entity - entity to upsert

timeout - max time for query to execute before erroring out

upsertEntityWithResponse

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

based on Mode it either inserts or merges if exists or inserts or merges if exists

Parameters:

updateMode - type of upsert

entity - entity to upsert

timeout - max time for query to execute before erroring out

context - the context of the query

Returns:

a response

updateEntity

public void updateEntity(TableEntity entity)

if UpdateMode is MERGE, merges or fails if the entity doesn't exist. If UpdateMode is REPLACE replaces or fails if the entity doesn't exist

Parameters:

entity - the entity to update

updateEntity

public void updateEntity(TableEntity entity,
                         UpdateMode updateMode)

if UpdateMode is MERGE, merges or fails if the entity doesn't exist. If UpdateMode is REPLACE replaces or fails if the entity doesn't exist

Parameters:

updateMode - which type of update to execute

entity - the entity to update

updateEntity

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

if UpdateMode is MERGE, merges or fails if the entity doesn't exist. If UpdateMode is REPLACE replaces or fails if the entity doesn't exist

Parameters:

updateMode - which type of update to execute

entity - the entity to update

ifUnchanged - if the eTag of the entity must match the entity in the service or not

updateEntity

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

if UpdateMode is MERGE, merges or fails if the entity doesn't exist. If UpdateMode is REPLACE replaces or fails if the entity doesn't exist

Parameters:

updateMode - which type of update to execute

entity - the entity to update

ifUnchanged - if the eTag of the entity must match the entity in the service or not

timeout - max time for query to execute before erroring out

updateEntityWithResponse

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

if UpdateMode is MERGE, merges or fails if the entity doesn't exist. If UpdateMode is REPLACE replaces or fails if the entity doesn't exist

Parameters:

updateMode - which type of update to execute

entity - the entity to update

ifUnchanged - if the eTag of the entity must match the entity in the service or not

timeout - max time for query to execute before erroring out

context - the context of the query

Returns:

a response

delete

public void delete()

deletes the table with the name of this client

delete

public void delete(Duration timeout)

deletes the table with the name of this client

Parameters:

timeout - Duration to wait for operation to complete.

deleteWithResponse

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

deletes the table with the name of this client

Parameters:

timeout - Duration to wait for operation to complete.

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

Returns:

The HTTP response.

deleteEntity

public void deleteEntity(String partitionKey,
                         String rowKey)

deletes the entity with the given partition key and row key

Parameters:

partitionKey - the partition key

rowKey - the row key

deleteEntity

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

deletes the entity with the given partition key and row key

Parameters:

partitionKey - the partition key

rowKey - the row key

eTag - the eTag of the entity, the delete will only occur if this matches the entity in the service

deleteEntity

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

deletes the given entity

Parameters:

partitionKey - the partition key

rowKey - the row key

eTag - the eTag of the entity, the delete will only occur if this matches the entity in the service

timeout - max time for query to execute before erroring out

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 the given entity

Parameters:

partitionKey - the partition key

rowKey - the row key

eTag - the eTag of the entity, the delete will only occur if this matches the entity in the service

timeout - max time for query to execute before erroring out

context - the context of the query

Returns:

a response

listEntities

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

Queries and returns all entities in the given table

Returns:

a list of the tables that fit the query

listEntities

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

Queries and returns entities in the given table using the odata QueryOptions

Parameters:

options - the odata query object

Returns:

a list of the tables that fit the query

listEntities

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

Queries and returns entities in the given table using the odata QueryOptions

Parameters:

options - the odata query object

timeout - max time for query to execute before erroring out

Returns:

a list of the tables that fit the query

getEntity

public TableEntity getEntity(String partitionKey,
                             String rowKey)

gets the entity which fits the given criteria

Parameters:

partitionKey - the partition key of the entity

rowKey - the row key of the entity

Returns:

the table entity

getEntityWithResponse

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

gets the entity which fits the given criteria

Parameters:

partitionKey - the partition key of the entity

rowKey - the row key of the entity

context - the context of the query

Returns:

a mono of the response with the table entity