TableEntity Class

  • java.lang.Object
    • com.azure.data.tables.models.TableEntity

public final class TableEntity

An entity within a table. A TableEntity can be used directly when interacting with the Tables service, with methods on the TableClient and TableAsyncClient classes that accept and return TableEntity instances. After creating an instance, call the addProperty(String key, Object value) or setProperties(Map<String,Object> properties) methods to add properties to the entity. When retrieving an entity from the service, call the getProperty(String key) or getProperties() methods to access the entity's properties.

Constructor Summary

Constructor Description
TableEntity(String partitionKey, String rowKey)

Construct a new TableEntity.

Method Summary

Modifier and Type Method and Description
TableEntity addProperty(String key, Object value)

Adds a single property to the entity's properties map.

String

getETag()

Gets the entity's eTag.

String

getPartitionKey()

Gets the entity's partition key.

Map<String,Object>

getProperties()

Gets the map of the entity's properties.

Object

getProperty(String key)

Gets a single property from the entity's properties map.

String

getRowKey()

Gets the entity's row key.

OffsetDateTime

getTimestamp()

Gets the entity's timestamp.

TableEntity setProperties(Map<String,Object> properties)

Sets the contents of the provided map to the entity's properties map.

Methods inherited from java.lang.Object

Constructor Details

TableEntity

public TableEntity(String partitionKey, String rowKey)

Construct a new TableEntity.

Parameters:

partitionKey - The partition key of the entity.
rowKey - The row key of the entity.

Method Details

addProperty

public TableEntity addProperty(String key, Object value)

Adds a single property to the entity's properties map.

Parameters:

key - Key for the property.
value - Value of the property.

Returns:

The updated TableEntity.

getETag

public String getETag()

Gets the entity's eTag. The eTag is automatically populated by the service. New TableEntity instances will not have an eTag, but an eTag will be present on any TableEntity returned from the service.

Returns:

The entity's eTag.

getPartitionKey

public String getPartitionKey()

Gets the entity's partition key.

Returns:

The entity's partition key.

getProperties

public Map getProperties()

Gets the map of the entity's properties. Only properties that have been added by calling addProperty(String key, Object value) or setProperties(Map<String,Object> properties) will be returned from this method.

Returns:

A map of all properties representing this entity, including system properties.

getProperty

public Object getProperty(String key)

Gets a single property from the entity's properties map. Only properties that have been added by calling addProperty(String key, Object value) or setProperties(Map<String,Object> properties) will be returned from this method.

Parameters:

key - Key for the property.

Returns:

Value of the property.

getRowKey

public String getRowKey()

Gets the entity's row key.

Returns:

The entity's row key.

getTimestamp

public OffsetDateTime getTimestamp()

Gets the entity's timestamp. The timestamp is automatically populated by the service. New TableEntity instances will not have a timestamp, but a timestamp will be present on any TableEntity returned from the service.

Returns:

The entity's timestamp.

setProperties

public TableEntity setProperties(Map properties)

Sets the contents of the provided map to the entity's properties map.

Parameters:

properties - The map of properties to set.

Returns:

The updated TableEntity.

Applies to