Package software.amazon.awssdk.services.dynamodb.document.api

Interface ListTablesApi

All Known Implementing Classes:

DynamoDb, ListTablesImpl

@ThreadSafe
public interface ListTablesApi

DynamoDB ListTables API.

Method Summary

Modifier and Type	Method	Description
TableCollection<ListTablesResponse>	listTables()	Returns a collection of all the tables (initialized with the respective table names) associated with the current account and endpoint.
TableCollection<ListTablesResponse>	listTables(int maxResultSize)	Returns a collection of tables (initialized with the respective table names) up to the specified maxResultSize associated with the current account and endpoint.
TableCollection<ListTablesResponse>	listTables(String exclusiveStartTableName)	Returns a collection of tables (initialized with the respective table names) associated with the current account and endpoint, starting with a name after the specified exclusiveStartTableName .
TableCollection<ListTablesResponse>	listTables(String exclusiveStartTableName, int maxResultSize)	Returns a collection of tables (initialized with the respective table names) up to the specified maxResultSize associated with the current account and endpoint, starting with a name after the specified exclusiveStartTableName.
TableCollection<ListTablesResponse>	listTables(ListTablesSpec spec)	List tables by specifying all the details.

Method Detail

listTables

TableCollection<ListTablesResponse> listTables()

Returns a collection of all the tables (initialized with the respective table names) associated with the current account and endpoint. The underlying collection is paginated with a page size of 100. A network call is made whenever the collection is iterated across a page boundary.

listTables

TableCollection<ListTablesResponse> listTables(String exclusiveStartTableName)

Returns a collection of tables (initialized with the respective table names) associated with the current account and endpoint, starting with a name after the specified exclusiveStartTableName . The underlying collection is paginated with a page size of 100. A network call is made whenever the collection is iterated across a page boundary.

Parameters:

exclusiveStartTableName - The first table name that this operation will evaluate, exclusive of the specified exclusiveStartTableName. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

listTables

TableCollection<ListTablesResponse> listTables(String exclusiveStartTableName,
                                               int maxResultSize)

Returns a collection of tables (initialized with the respective table names) up to the specified maxResultSize associated with the current account and endpoint, starting with a name after the specified exclusiveStartTableName. The underlying collection is paginated with a page size of 100. A network call is made whenever the collection is iterated across a page boundary.

Parameters:

exclusiveStartTableName - The first table name that this operation will evaluate exclusive of the specified exclusiveStartTableName. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

maxResultSize - A maximum number of table names to return.

listTables

TableCollection<ListTablesResponse> listTables(int maxResultSize)

Returns a collection of tables (initialized with the respective table names) up to the specified maxResultSize associated with the current account and endpoint. The underlying collection is paginated with a page size of 100. A network call is made whenever the collection is iterated across a page boundary.

Parameters:

maxResultSize - A maximum number of table names to return.

listTables

TableCollection<ListTablesResponse> listTables(ListTablesSpec spec)

List tables by specifying all the details. The underlying collection is paginated with the specified page size (which defaults to 100). A network call is made whenever the collection is iterated across a page boundary.

Parameters:

spec - can be used to specify all the detailed parameters of listing tables.

Returns:

a collection of tables associated with the current account and endpoint.