com.microsoft.azure.storage.table

Class CloudTable

java.lang.Object

com.microsoft.azure.storage.table.CloudTable

public final class CloudTable
extends Object

Represents a table in the Microsoft Azure Table service.

Constructor Summary

Constructors

Constructor and Description
CloudTable(StorageUri uri) Creates an instance of the CloudTable class using the specified table URI.
CloudTable(StorageUri uri, CloudTableClient client) Deprecated. as of 3.0.0. Please use CloudTable(StorageUri, StorageCredentials)
CloudTable(StorageUri uri, StorageCredentials credentials) Creates an instance of the CloudTable class using the specified table StorageUri and credentials.
CloudTable(String tableName, CloudTableClient client) Deprecated. as of 3.0.0. Please use CloudTableClient.getTableReference(String)
CloudTable(URI uri) Creates an instance of the CloudTable class using the specified table URI.
CloudTable(URI uri, CloudTableClient client) Deprecated. as of 3.0.0. Please use CloudTable(URI, StorageCredentials)
CloudTable(URI uri, StorageCredentials credentials) Creates an instance of the CloudTable class using the specified table URI and credentials.

Method Summary

Methods

Modifier and Type	Method and Description
void	create() Creates the table in the storage service with default request options.
void	create(TableRequestOptions options, OperationContext opContext) Creates the table in the storage service, using the specified TableRequestOptions and OperationContext.
boolean	createIfNotExists() Creates the table in the storage service using default request options if it does not already exist.
boolean	createIfNotExists(TableRequestOptions options, OperationContext opContext) Creates the table in the storage service with the specified request options and operation context, if it does not already exist.
void	delete() Deletes the table from the storage service.
void	delete(TableRequestOptions options, OperationContext opContext) Deletes the table from the storage service, using the specified request options and operation context.
boolean	deleteIfExists() Deletes the table from the storage service, if it exists.
boolean	deleteIfExists(TableRequestOptions options, OperationContext opContext) Deletes the table from the storage service using the specified request options and operation context, if it exists.
TablePermissions	downloadPermissions() Downloads the permission settings for the table.
TablePermissions	downloadPermissions(TableRequestOptions options, OperationContext opContext) Downloads the permissions settings for the table using the specified request options and operation context.
ArrayList<TableResult>	execute(TableBatchOperation batch) Executes the specified batch operation on a table as an atomic operation.
ArrayList<TableResult>	execute(TableBatchOperation batch, TableRequestOptions options, OperationContext opContext) Executes the specified batch operation on a table as an atomic operation, using the specified TableRequestOptions and OperationContext.
TableResult	execute(TableOperation operation) Executes the operation on a table.
TableResult	execute(TableOperation operation, TableRequestOptions options, OperationContext opContext) Executes the operation on a table, using the specified TableRequestOptions and OperationContext.
<R> Iterable<R>	execute(TableQuery<?> query, EntityResolver<R> resolver) Executes a query, applying the specified EntityResolver to the result.
<R> Iterable<R>	execute(TableQuery<?> query, EntityResolver<R> resolver, TableRequestOptions options, OperationContext opContext) Executes a query, applying the specified EntityResolver to the result, using the specified TableRequestOptions and OperationContext.
<T extends TableEntity> Iterable<T>	execute(TableQuery<T> query) Executes a query.
<T extends TableEntity> Iterable<T>	execute(TableQuery<T> query, TableRequestOptions options, OperationContext opContext) Executes a query, using the specified TableRequestOptions and OperationContext.
<R> ResultSegment<R>	executeSegmented(TableQuery<?> query, EntityResolver<R> resolver, ResultContinuation continuationToken) Executes a query in segmented mode with the specified ResultContinuation continuation token, applying the EntityResolver to the result.
<R> ResultSegment<R>	executeSegmented(TableQuery<?> query, EntityResolver<R> resolver, ResultContinuation continuationToken, TableRequestOptions options, OperationContext opContext) Executes a query in segmented mode with the specified ResultContinuation continuation token, using the specified TableRequestOptions and OperationContext, applying the EntityResolver to the result.
<T extends TableEntity> ResultSegment<T>	executeSegmented(TableQuery<T> query, ResultContinuation continuationToken) Executes a query in segmented mode with a ResultContinuation continuation token.
<T extends TableEntity> ResultSegment<T>	executeSegmented(TableQuery<T> query, ResultContinuation continuationToken, TableRequestOptions options, OperationContext opContext) Executes a query in segmented mode with a ResultContinuation continuation token, using the specified TableRequestOptions and OperationContext.
boolean	exists() Returns a value that indicates whether the table exists in the storage service.
boolean	exists(TableRequestOptions options, OperationContext opContext) Returns a value that indicates whether the table exists in the storage service, using the specified request options and operation context.
String	generateSharedAccessSignature(SharedAccessTablePolicy policy, String accessPolicyIdentifier, String startPartitionKey, String startRowKey, String endPartitionKey, String endRowKey) Creates a shared access signature for the table.
String	getName() Gets the name of the table.
CloudTableClient	getServiceClient() Gets the table service client associated with this queue.
StorageUri	getStorageUri() Returns the list of URIs for all locations.
URI	getUri() Gets the absolute URI for this table.
void	uploadPermissions(TablePermissions permissions) Uploads the table's permissions.
void	uploadPermissions(TablePermissions permissions, TableRequestOptions options, OperationContext opContext) Uploads the table's permissions using the specified request options and operation context.

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudTable

public CloudTable(URI uri)
           throws StorageException

Creates an instance of the CloudTable class using the specified table URI. The table URI must include a SAS token.

Parameters:

uri - A java.net.URI object that represents the absolute URI of the table.

Throws:

StorageException - If a storage service error occurred.

CloudTable

public CloudTable(StorageUri uri)
           throws StorageException

Creates an instance of the CloudTable class using the specified table URI. The table URI must include a SAS token.

Parameters:

uri - A StorageUri object that represents the absolute URI of the table.

Throws:

StorageException - If a storage service error occurred.

CloudTable

public CloudTable(URI uri,
          StorageCredentials credentials)
           throws StorageException

Creates an instance of the CloudTable class using the specified table URI and credentials.

Parameters:

uri - A java.net.URI object that represents the absolute URI of the table.

credentials - A StorageCredentials object used to authenticate access.

Throws:

StorageException - If a storage service error occurred.

CloudTable

public CloudTable(StorageUri uri,
          StorageCredentials credentials)
           throws StorageException

Creates an instance of the CloudTable class using the specified table StorageUri and credentials.

Parameters:

uri - A StorageUri object that represents the absolute StorageUri of the table.

credentials - A StorageCredentials object used to authenticate access.

Throws:

StorageException - If a storage service error occurred.

CloudTable

@Deprecated
public CloudTable(String tableName,
                     CloudTableClient client)
           throws URISyntaxException,
                  StorageException

Deprecated. as of 3.0.0. Please use CloudTableClient.getTableReference(String)

Creates an instance of the CloudTable class using the specified name and client.

Parameters:

tableName - A String which represents the name of the table, which must adhere to table naming rules. The table name should not include any path separator characters (/). Table names are case insensitive, must be unique within an account and must be between 3-63 characters long. Table names must start with an cannot begin with a numeric character and may only contain alphanumeric characters. Some table names are reserved, including "table".

client - A CloudTableClient object that represents the associated service client, and that specifies the endpoint for the Table service.

Throws:

URISyntaxException - If the resource URI constructed based on the tableName is invalid.

StorageException - If a storage service error occurred.

See Also:

Understanding the Table Service Data Model

CloudTable

@Deprecated
public CloudTable(URI uri,
                     CloudTableClient client)
           throws URISyntaxException,
                  StorageException

Deprecated. as of 3.0.0. Please use CloudTable(URI, StorageCredentials)

Creates an instance of the CloudTable class using the specified table URI and client.

Parameters:

uri - A java.net.URI object that represents the absolute URI of the table.

client - A CloudTableClient object that represents the associated service client, and that specifies the endpoint for the Table service.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

CloudTable

@Deprecated
public CloudTable(StorageUri uri,
                     CloudTableClient client)
           throws URISyntaxException,
                  StorageException

Deprecated. as of 3.0.0. Please use CloudTable(StorageUri, StorageCredentials)

Creates an instance of the CloudTable class using the specified table StorageUri and client.

Parameters:

uri - A StorageUri object that represents the absolute StorageUri of the table.

client - A CloudTableClient object that represents the associated service client, and that specifies the endpoint for the Table service.

Throws:

StorageException - If a storage service error occurred.

URISyntaxException - If the resource URI is invalid.

Method Detail

getName

public String getName()

Gets the name of the table.

Returns:

A String object that represents the name of the table.

getServiceClient

public CloudTableClient getServiceClient()

Gets the table service client associated with this queue.

Returns:

A CloudTableClient object that represents the service client associated with this table.

getStorageUri

public final StorageUri getStorageUri()

Returns the list of URIs for all locations.

Returns:

A StorageUri that represents the list of URIs for all locations..

getUri

public URI getUri()

Gets the absolute URI for this table.

Returns:

A java.net.URI object that represents the URI for this table.

create

@DoesServiceRequest
public void create()
            throws StorageException

Creates the table in the storage service with default request options.

This method invokes the Create Table REST API to create the specified table, using the Table service endpoint and storage account credentials of this instance.

Throws:

StorageException - If a storage service error occurred during the operation.

create

@DoesServiceRequest
public void create(TableRequestOptions options,
                             OperationContext opContext)
            throws StorageException

Creates the table in the storage service, using the specified TableRequestOptions and OperationContext.

This method invokes the Create Table REST API to create the specified table, using the Table service endpoint and storage account credentials of this instance. Use the TableRequestOptions to override execution options such as the timeout or retry policy for the operation.

Parameters:

options - A TableRequestOptions object that specifies execution options such as retry policy and timeout settings for the operation. Specify null to use the request options specified on the CloudTableClient.

opContext - An OperationContext object for tracking the current operation. Specify null to safely ignore operation context.

Throws:

StorageException - If an error occurs accessing the storage service, or because the table cannot be created, or already exists.

createIfNotExists

@DoesServiceRequest
public boolean createIfNotExists()
                          throws StorageException

Creates the table in the storage service using default request options if it does not already exist.

Returns:

true if the table is created in the storage service; otherwise false.

Throws:

StorageException - If a storage service error occurred during the operation.

createIfNotExists

@DoesServiceRequest
public boolean createIfNotExists(TableRequestOptions options,
                                           OperationContext opContext)
                          throws StorageException

Creates the table in the storage service with the specified request options and operation context, if it does not already exist.

Parameters:

options - A TableRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudTableClient).

opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

true if the table did not already exist and was created; otherwise false .

Throws:

StorageException - If a storage service error occurred during the operation.

delete

@DoesServiceRequest
public void delete()
            throws StorageException

Deletes the table from the storage service.

Throws:

StorageException - If a storage service error occurred during the operation.

delete

@DoesServiceRequest
public void delete(TableRequestOptions options,
                             OperationContext opContext)
            throws StorageException

Deletes the table from the storage service, using the specified request options and operation context.

Parameters:

options - A TableRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudTableClient).

opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred during the operation.

deleteIfExists

@DoesServiceRequest
public boolean deleteIfExists()
                       throws StorageException

Deletes the table from the storage service, if it exists.

Returns:

true if the table existed in the storage service and has been deleted; otherwise false.

Throws:

StorageException - If a storage service error occurred during the operation.

deleteIfExists

@DoesServiceRequest
public boolean deleteIfExists(TableRequestOptions options,
                                        OperationContext opContext)
                       throws StorageException

Deletes the table from the storage service using the specified request options and operation context, if it exists.

Parameters:

options - A TableRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudTableClient).

opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A value of true if the table existed in the storage service and has been deleted, otherwise false.

Throws:

StorageException - If a storage service error occurred during the operation.

execute

@DoesServiceRequest
public ArrayList<TableResult> execute(TableBatchOperation batch)
                               throws StorageException

Executes the specified batch operation on a table as an atomic operation. A batch operation may contain up to 100 individual table operations, with the requirement that each operation entity must have same partition key. Only one retrieve operation is allowed per batch. Note that the total payload of a batch operation is limited to 4MB.

This method invokes an Entity Group Transaction on the REST API to execute the specified batch operation on the table as an atomic unit, using the Table service endpoint and storage account credentials of this instance.

Parameters:

batch - The TableBatchOperation object representing the operations to execute on the table.

Returns:

A java.util.ArrayList of TableResult that contains the results, in order, of each TableOperation in the TableBatchOperation on the named table.

Throws:

StorageException - if an error occurs accessing the storage service, or the operation fails.

execute

@DoesServiceRequest
public ArrayList<TableResult> execute(TableBatchOperation batch,
                                                TableRequestOptions options,
                                                OperationContext opContext)
                               throws StorageException

Executes the specified batch operation on a table as an atomic operation, using the specified TableRequestOptions and OperationContext. A batch operation may contain up to 100 individual table operations, with the requirement that each operation entity must have same partition key. Only one retrieve operation is allowed per batch. Note that the total payload of a batch operation is limited to 4MB.

This method invokes an Entity Group Transaction on the REST API to execute the specified batch operation on the table as an atomic unit, using the Table service endpoint and storage account credentials of this instance. Use the TableRequestOptions to override execution options such as the timeout or retry policy for the operation.

Parameters:

batch - The TableBatchOperation object representing the operations to execute on the table.

options - A TableRequestOptions object that specifies execution options such as retry policy and timeout settings for the operation. Specify null to use the request options specified on the CloudTableClient.

opContext - An OperationContext object for tracking the current operation. Specify null to safely ignore operation context.

Returns:

A java.util.ArrayList of TableResult that contains the results, in order, of each TableOperation in the TableBatchOperation on the named table.

Throws:

StorageException - if an error occurs accessing the storage service, or the operation fails.

execute

@DoesServiceRequest
public TableResult execute(TableOperation operation)
                    throws StorageException

Executes the operation on a table.

This method will invoke the Table Service REST API to execute the specified operation on the table, using the Table service endpoint and storage account credentials of this instance.

Parameters:

operation - The TableOperation object representing the operation to execute on the table.

Returns:

A TableResult containing the result of executing the TableOperation on the table.

Throws:

StorageException - if an error occurs accessing the storage service, or the operation fails.

execute

@DoesServiceRequest
public TableResult execute(TableOperation operation,
                                     TableRequestOptions options,
                                     OperationContext opContext)
                    throws StorageException

Executes the operation on a table, using the specified TableRequestOptions and OperationContext.

This method will invoke the Table Service REST API to execute the specified operation on the table, using the Table service endpoint and storage account credentials of this instance. Use the TableRequestOptions to override execution options such as the timeout or retry policy for the operation.

Parameters:

operation - The TableOperation object representing the operation to execute on the table.

options - A TableRequestOptions object that specifies execution options such as retry policy and timeout settings for the operation. Specify null to use the request options specified on the CloudTableClient.

opContext - An OperationContext object for tracking the current operation. Specify null to safely ignore operation context.

Returns:

A TableResult containing the result of executing the TableOperation on the table.

Throws:

StorageException - if an error occurs accessing the storage service, or the operation fails.

execute

@DoesServiceRequest
public <R> Iterable<R> execute(TableQuery<?> query,
                                         EntityResolver<R> resolver)

Executes a query, applying the specified EntityResolver to the result.

This method will invoke a Query Entities operation on the Table Service REST API to query the table, using the Table service endpoint and storage account credentials of this instance.

Parameters:

query - A TableQuery instance specifying the table to query and the query parameters to use.

resolver - An EntityResolver instance which creates a projection of the table query result entities into the specified type R.

Returns:

A collection implementing the Iterable interface containing the projection into type R of the results of executing the query.

execute

@DoesServiceRequest
public <R> Iterable<R> execute(TableQuery<?> query,
                                         EntityResolver<R> resolver,
                                         TableRequestOptions options,
                                         OperationContext opContext)

Executes a query, applying the specified EntityResolver to the result, using the specified TableRequestOptions and OperationContext.

This method will invoke a Query Entities operation on the Table Service REST API to query the table, using the Table service endpoint and storage account credentials of this instance. Use the TableRequestOptions to override execution options such as the timeout or retry policy for the operation.

Parameters:

query - A TableQuery instance specifying the table to query and the query parameters to use.

resolver - An EntityResolver instance which creates a projection of the table query result entities into the specified type R.

options - A TableRequestOptions object that specifies execution options such as retry policy and timeout settings for the operation. Specify null to use the request options specified on the CloudTableClient.

opContext - An OperationContext object for tracking the current operation. Specify null to safely ignore operation context.

Returns:

A collection implementing the Iterable interface containing the projection into type R of the results of executing the query.

execute

@DoesServiceRequest
public <T extends TableEntity> Iterable<T> execute(TableQuery<T> query)

Executes a query.

This method will invoke a Query Entities operation on the Table Service REST API to query the table, using the Table service endpoint and storage account credentials of this instance.

Parameters:

query - A TableQuery instance specifying the table to query and the query parameters to use, specialized for a type T implementing TableEntity.

Returns:

A collection implementing the Iterable interface specialized for type T of the results of executing the query.

execute

@DoesServiceRequest
public <T extends TableEntity> Iterable<T> execute(TableQuery<T> query,
                                                             TableRequestOptions options,
                                                             OperationContext opContext)

Executes a query, using the specified TableRequestOptions and OperationContext.

This method will invoke a Query Entities operation on the Table Service REST API to query the table, using the Table service endpoint and storage account credentials of this instance. Use the TableRequestOptions to override execution options such as the timeout or retry policy for the operation.

Parameters:

query - A TableQuery instance specifying the table to query and the query parameters to use, specialized for a type T implementing TableEntity.

options - A TableRequestOptions object that specifies execution options such as retry policy and timeout settings for the operation. Specify null to use the request options specified on the CloudTableClient.

opContext - An OperationContext object for tracking the current operation. Specify null to safely ignore operation context.

Returns:

A collection implementing the Iterable interface specialized for type T of the results of executing the query.

executeSegmented

@DoesServiceRequest
public <R> ResultSegment<R> executeSegmented(TableQuery<?> query,
                                                       EntityResolver<R> resolver,
                                                       ResultContinuation continuationToken)
                                  throws StorageException

Executes a query in segmented mode with the specified ResultContinuation continuation token, applying the EntityResolver to the result. Executing a query with executeSegmented allows the query to be resumed after returning partial results, using information returned by the server in the ResultSegment object.

This method will invoke a Query Entities operation on the Table Service REST API to query the table, using the Table service endpoint and storage account credentials of this instance.

Parameters:

query - A TableQuery instance specifying the table to query and the query parameters to use.

resolver - An EntityResolver instance which creates a projection of the table query result entities into the specified type R.

continuationToken - A ResultContinuation object representing a continuation token from the server when the operation returns a partial result. Specify null on the initial call. Call the ResultSegment.getContinuationToken() method on the result to obtain the ResultContinuation object to use in the next call to resume the query.

Returns:

A ResultSegment containing the projection into type R of the results of executing the query.

Throws:

StorageException - if a storage service error occurred during the operation.

executeSegmented

@DoesServiceRequest
public <R> ResultSegment<R> executeSegmented(TableQuery<?> query,
                                                       EntityResolver<R> resolver,
                                                       ResultContinuation continuationToken,
                                                       TableRequestOptions options,
                                                       OperationContext opContext)
                                  throws StorageException

Executes a query in segmented mode with the specified ResultContinuation continuation token, using the specified TableRequestOptions and OperationContext, applying the EntityResolver to the result. Executing a query with executeSegmented allows the query to be resumed after returning partial results, using information returned by the server in the ResultSegment object.

This method will invoke a Query Entities operation on the Table Service REST API to query the table, using the Table service endpoint and storage account credentials of this instance. Use the TableRequestOptions to override execution options such as the timeout or retry policy for the operation.

Parameters:

query - A TableQuery instance specifying the table to query and the query parameters to use.

resolver - An EntityResolver instance which creates a projection of the table query result entities into the specified type R.

continuationToken - A ResultContinuation object representing a continuation token from the server when the operation returns a partial result. Specify null on the initial call. Call the ResultSegment.getContinuationToken() method on the result to obtain the ResultContinuation object to use in the next call to resume the query.

options - A TableRequestOptions object that specifies execution options such as retry policy and timeout settings for the operation. Specify null to use the request options specified on the CloudTableClient.

opContext - An OperationContext object for tracking the current operation. Specify null to safely ignore operation context.

Returns:

A ResultSegment containing the projection into type R of the results of executing the query.

Throws:

StorageException - if a storage service error occurred during the operation.

executeSegmented

@DoesServiceRequest
public <T extends TableEntity> ResultSegment<T> executeSegmented(TableQuery<T> query,
                                                                           ResultContinuation continuationToken)
                                                      throws StorageException

Executes a query in segmented mode with a ResultContinuation continuation token. Executing a query with executeSegmented allows the query to be resumed after returning partial results, using information returned by the server in the ResultSegment object.

This method will invoke a Query Entities operation on the Table Service REST API to query the table, using the Table service endpoint and storage account credentials of this instance.

Parameters:

query - A TableQuery instance specifying the table to query and the query parameters to use, specialized for a type T implementing TableEntity.

continuationToken - A ResultContinuation object representing a continuation token from the server when the operation returns a partial result. Specify null on the initial call. Call the ResultSegment.getContinuationToken() method on the result to obtain the ResultContinuation object to use in the next call to resume the query.

Returns:

A ResultSegment specialized for type T of the results of executing the query.

Throws:

StorageException - if a storage service error occurred during the operation.

executeSegmented

@DoesServiceRequest
public <T extends TableEntity> ResultSegment<T> executeSegmented(TableQuery<T> query,
                                                                           ResultContinuation continuationToken,
                                                                           TableRequestOptions options,
                                                                           OperationContext opContext)
                                                      throws StorageException

Executes a query in segmented mode with a ResultContinuation continuation token, using the specified TableRequestOptions and OperationContext. Executing a query with executeSegmented allows the query to be resumed after returning partial results, using information returned by the server in the ResultSegment object.

This method will invoke a Query Entities operation on the Table Service REST API to query the table, using the Table service endpoint and storage account credentials of this instance. Use the TableRequestOptions to override execution options such as the timeout or retry policy for the operation.

Parameters:

query - A TableQuery instance specifying the table to query and the query parameters to use, specialized for a type T implementing TableEntity.

continuationToken - A ResultContinuation object representing a continuation token from the server when the operation returns a partial result. Specify null on the initial call. Call the ResultSegment.getContinuationToken() method on the result to obtain the ResultContinuation object to use in the next call to resume the query.

options - A TableRequestOptions object that specifies execution options such as retry policy and timeout settings for the operation. Specify null to use the request options specified on the CloudTableClient.

opContext - An OperationContext object for tracking the current operation. Specify null to safely ignore operation context.

Returns:

A ResultSegment specialized for type T of the results of executing the query.

Throws:

StorageException - if a storage service error occurred during the operation.

exists

@DoesServiceRequest
public boolean exists()
               throws StorageException

Returns a value that indicates whether the table exists in the storage service.

Returns:

true if the table exists in the storage service; otherwise false.

Throws:

StorageException - If a storage service error occurred during the operation.

exists

@DoesServiceRequest
public boolean exists(TableRequestOptions options,
                                OperationContext opContext)
               throws StorageException

Returns a value that indicates whether the table exists in the storage service, using the specified request options and operation context.

Parameters:

options - A TableRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudTableClient).

opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

true if the table exists in the storage service, otherwise false.

Throws:

StorageException - If a storage service error occurred during the operation.

uploadPermissions

@DoesServiceRequest
public void uploadPermissions(TablePermissions permissions)
                       throws StorageException

Uploads the table's permissions.

Parameters:

permissions - A TablePermissions object that represents the permissions to upload.

Throws:

StorageException - If a storage service error occurred.

uploadPermissions

@DoesServiceRequest
public void uploadPermissions(TablePermissions permissions,
                                        TableRequestOptions options,
                                        OperationContext opContext)
                       throws StorageException

Uploads the table's permissions using the specified request options and operation context.

Parameters:

permissions - A TablePermissions object that represents the permissions to upload.

options - A TableRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudTableClient).

opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

downloadPermissions

@DoesServiceRequest
public TablePermissions downloadPermissions()
                                     throws StorageException

Downloads the permission settings for the table.

Returns:

A TablePermissions object that represents the container's permissions.

Throws:

StorageException - If a storage service error occurred.

downloadPermissions

@DoesServiceRequest
public TablePermissions downloadPermissions(TableRequestOptions options,
                                                      OperationContext opContext)
                                     throws StorageException

Downloads the permissions settings for the table using the specified request options and operation context.

Parameters:

options - A TableRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudTableClient).

opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A TablePermissions object that represents the table's permissions.

Throws:

StorageException - If a storage service error occurred.

generateSharedAccessSignature

public String generateSharedAccessSignature(SharedAccessTablePolicy policy,
                                   String accessPolicyIdentifier,
                                   String startPartitionKey,
                                   String startRowKey,
                                   String endPartitionKey,
                                   String endRowKey)
                                     throws InvalidKeyException,
                                            StorageException

Creates a shared access signature for the table.

Parameters:

policy - A SharedAccessTablePolicy object which represents the access policy for the shared access signature.

accessPolicyIdentifier - A String which represents a table-level access policy.

startPartitionKey - A String which represents the starting partition key.

startRowKey - A String which represents the starting row key.

endPartitionKey - A String which represents the ending partition key.

endRowKey - A String which represents the ending end key.

Returns:

A String containing the shared access signature for the table.

Throws:

InvalidKeyException - If an invalid key was passed.

StorageException - If a storage service error occurred.

IllegalArgumentException - If an unexpected value is passed.