com.azure.data.tables

Class TableServiceAsyncClient

java.lang.Object

com.azure.data.tables.TableServiceAsyncClient

public class TableServiceAsyncClient
extends Object

Provides an asynchronous 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.buildAsyncClient() method on a TableServiceClientBuilder object.

Method Summary

Modifier and Type	Method and Description
Mono<Void>	createTable(String tableName) Creates a table within the Tables service.
Mono<Void>	createTableIfNotExists(String tableName) Creates a table within the Tables service if the table does not already exist.
Mono<com.azure.core.http.rest.Response<Void>>	createTableIfNotExistsWithResponse(String tableName) Creates a table within the Tables service if the table does not already exist.
Mono<com.azure.core.http.rest.Response<Void>>	createTableWithResponse(String tableName) Creates a table within the Tables service.
Mono<Void>	deleteTable(String tableName) Deletes a table within the Tables service.
Mono<com.azure.core.http.rest.Response<Void>>	deleteTableWithResponse(String tableName) 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.
TableAsyncClient	getTableClient(String tableName) Gets a TableAsyncClient instance for the provided table in the account.
com.azure.core.http.rest.PagedFlux<TableItem>	listTables() Lists all tables within the account.
com.azure.core.http.rest.PagedFlux<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 TableAsyncClient getTableClient(String tableName)

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

Parameters:

tableName - The name of the table.

Returns:

A TableAsyncClient instance for the provided table in the account.

Throws:

NullPointerException - if tableName is null or empty.

createTable

public Mono<Void> createTable(String tableName)

Creates a table within the Tables service.

Parameters:

tableName - The name of the table to create.

Returns:

An empty reactive result.

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.

createTableWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> createTableWithResponse(String tableName)

Creates a table within the Tables service.

Parameters:

tableName - The name of the table to create.

Returns:

A reactive result containing 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.

createTableIfNotExists

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

Returns:

An empty reactive result.

Throws:

IllegalArgumentException - if tableName is null or empty.

createTableIfNotExistsWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> createTableIfNotExistsWithResponse(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.

Returns:

A reactive result containing the HTTP response.

Throws:

IllegalArgumentException - if tableName is null or empty.

deleteTable

public Mono<Void> deleteTable(String tableName)

Deletes a table within the Tables service.

Parameters:

tableName - The name of the table to delete.

Returns:

An empty reactive result.

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.

deleteTableWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> deleteTableWithResponse(String tableName)

Deletes a table within the Tables service.

Parameters:

tableName - The name of the table to delete.

Returns:

A reactive result containing 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.

listTables

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

Lists all tables within the account.

Returns:

A paged reactive result containing all tables within the account.

listTables

public com.azure.core.http.rest.PagedFlux<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 reactive result containing matching tables within the account.

Throws:

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