com.azure.data.tables

Class TableServiceClient

java.lang.Object

com.azure.data.tables.TableServiceClient

public class TableServiceClient
extends Object

Provides a synchronous service client for accessing the Azure Tables service. The client encapsulates the URL for the Tables service endpoint and the credentials for accessing the storage or CosmosDB table API account. It provides methods to create, delete, and list tables within the account. 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 TableServiceClientBuilder.buildClient() method on a TableServiceClientBuilder object.

Method Summary

Modifier and Type	Method and Description
void	createTable(String tableName) Creates a table within the Tables service.
void	createTable(String tableName, Duration timeout) Creates a table within the Tables service.
void	createTableIfNotExists(String tableName) Creates a table within the Tables service if the table does not already exist.
void	createTableIfNotExists(String tableName, Duration timeout) Creates a table within the Tables service if the table does not already exist.
com.azure.core.http.rest.Response<Void>	createTableIfNotExistsWithResponse(String tableName, Duration timeout, com.azure.core.util.Context context) Creates a table within the Tables service if the table does not already exist.
com.azure.core.http.rest.Response<Void>	createTableWithResponse(String tableName, Duration timeout, com.azure.core.util.Context context) Creates a table within the Tables service.
void	deleteTable(String tableName) Deletes a table within the Tables service.
void	deleteTable(String tableName, Duration timeout) Deletes a table within the Tables service.
com.azure.core.http.rest.Response<Void>	deleteTableWithResponse(String tableName, Duration timeout, com.azure.core.util.Context context) Deletes a 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.
String	getServiceUrl() Gets the absolute URL for the Tables service endpoint.
TableClient	getTableClient(String tableName) Gets a TableClient instance for the provided table in the account.
com.azure.core.http.rest.PagedIterable<TableItem>	listTables() Lists all tables within the account.
com.azure.core.http.rest.PagedIterable<TableItem>	listTables(ListTablesOptions options) Lists tables using the parameters in the provided options.

Methods inherited from class java.lang.Object

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

Method Detail

getAccountName

public String getAccountName()

Gets the name of the account containing the table.

Returns:

The name of the account containing the table.

getServiceUrl

public String getServiceUrl()

Gets the absolute URL for the Tables service endpoint.

Returns:

The absolute URL for the Tables service endpoint.

getApiVersion

public TablesServiceVersion getApiVersion()

Gets the REST API version used by this client.

Returns:

The REST API version used by this client.

getTableClient

public TableClient getTableClient(String tableName)

Gets a TableClient instance for the provided table in the account.

Parameters:

tableName - The name of the table.

Returns:

A TableClient instance for the provided table in the account.

Throws:

IllegalArgumentException - if tableName is null or empty.

createTable

public void createTable(String tableName)

Creates a table within the Tables service.

Parameters:

tableName - The name of the table to create.

Throws:

IllegalArgumentException - if tableName is null or empty.

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

createTable

public void createTable(String tableName,
                        Duration timeout)

Creates a table within the Tables service.

Parameters:

tableName - The name of the table to create.

timeout - Duration to wait for the operation to complete.

Throws:

IllegalArgumentException - if tableName is null or empty.

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.

createTableWithResponse

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

Creates a table within the Tables service.

Parameters:

tableName - The name of the table to create.

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:

IllegalArgumentException - if tableName is null or empty.

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.

createTableIfNotExists

public void createTableIfNotExists(String tableName)

Creates a table within the Tables service if the table does not already exist.

Parameters:

tableName - The name of the table to create.

Throws:

IllegalArgumentException - if tableName is null or empty.

createTableIfNotExists

public void createTableIfNotExists(String tableName,
                                   Duration timeout)

Creates a table within the Tables service if the table does not already exist.

Parameters:

tableName - The name of the table to create.

timeout - Duration to wait for the operation to complete.

Throws:

IllegalArgumentException - if tableName is null or empty.

RuntimeException - if the provided timeout expires.

createTableIfNotExistsWithResponse

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

Creates a table within the Tables service if the table does not already exist.

Parameters:

tableName - The name of the table to create.

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:

IllegalArgumentException - if tableName is null or empty.

RuntimeException - if the provided timeout expires.

deleteTable

public void deleteTable(String tableName)

Deletes a table within the Tables service.

Parameters:

tableName - The name of the table to delete.

Throws:

IllegalArgumentException - if tableName is null or empty.

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

deleteTable

public void deleteTable(String tableName,
                        Duration timeout)

Deletes a table within the Tables service.

Parameters:

tableName - The name of the table to delete.

timeout - Duration to wait for the operation to complete.

Throws:

IllegalArgumentException - if tableName is null or empty.

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

RuntimeException - if the provided timeout expires.

deleteTableWithResponse

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

Deletes a table within the Tables service.

Parameters:

tableName - The name of the table to delete.

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:

IllegalArgumentException - if tableName is null or empty.

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

RuntimeException - if the provided timeout expires.

listTables

public com.azure.core.http.rest.PagedIterable<TableItem> listTables()

Lists all tables within the account.

Returns:

A paged iterable containing all tables within the account.

listTables

public com.azure.core.http.rest.PagedIterable<TableItem> listTables(ListTablesOptions options)

Lists tables using the parameters in the provided options. If the `filter` parameter in the options is set, only tables matching the filter will be returned. If the `top` parameter is set, the number of returned tables will be limited to that value.

Parameters:

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

Returns:

A paged iterable containing matching tables within the account.

Throws:

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