Package com.amazonaws.athena.connector.lambda.metadata

Class ListTablesRequest

java.lang.Object

com.amazonaws.athena.connector.lambda.request.FederationRequest

com.amazonaws.athena.connector.lambda.metadata.MetadataRequest

com.amazonaws.athena.connector.lambda.metadata.ListTablesRequest

All Implemented Interfaces:

AutoCloseable

public class ListTablesRequest
extends MetadataRequest

Represents the input of a ListTables operation.

Field Summary

Fields

Modifier and Type	Field	Description
static int	UNLIMITED_PAGE_SIZE_VALUE	Value used to indicate that the page size is unlimited, and therefore, the request should NOT be paginated.

Constructor Summary

Constructors

Constructor	Description
ListTablesRequest(FederatedIdentity identity, String queryId, String catalogName, String schemaName, String nextToken, int pageSize)	Constructs a new ListTablesRequest object.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	equals(Object o)
String	getNextToken()	Gets the pagination starting point for the next page.
int	getPageSize()	Gets the page size used for pagination.
String	getSchemaName()	Returns the schema name that tables should be listed for.
int	hashCode()
String	toString()

Methods inherited from class com.amazonaws.athena.connector.lambda.metadata.MetadataRequest

getCatalogName, getContext, getQueryId, getRequestType, setContext

Methods inherited from class com.amazonaws.athena.connector.lambda.request.FederationRequest

getIdentity

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNLIMITED_PAGE_SIZE_VALUE

public static final int UNLIMITED_PAGE_SIZE_VALUE

Value used to indicate that the page size is unlimited, and therefore, the request should NOT be paginated.

See Also:

Constant Field Values

Constructor Detail

ListTablesRequest

public ListTablesRequest(FederatedIdentity identity,
                         String queryId,
                         String catalogName,
                         String schemaName,
                         String nextToken,
                         int pageSize)

Constructs a new ListTablesRequest object.

Parameters:

identity - The identity of the caller.

queryId - The ID of the query requesting metadata.

catalogName - The catalog name that tables should be listed for.

schemaName - The schema name that tables should be listed for. This may be null if no specific schema is requested.

nextToken - The pagination starting point for the next page (null indicates the first paginated request).

pageSize - The page size used for pagination (UNLIMITED_PAGE_SIZE_VALUE indicates the request should not be paginated).

Method Detail

getSchemaName

public String getSchemaName()

Returns the schema name that tables should be listed for. This may be null if no specific schema is requested.

Returns:

The schema name that tables should be listed for. This may be null if no specific schema is requested.

getNextToken

public String getNextToken()

Gets the pagination starting point for the next page.

Returns:

The pagination starting point for the next page (null indicates the first paginated request).

getPageSize

public int getPageSize()

Gets the page size used for pagination.

Returns:

The page size used for pagination (UNLIMITED_PAGE_SIZE_VALUE indicates the request should not be paginated).

close

public void close()
           throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object