Package software.amazon.awssdk.services.athena.model

Class ListTableMetadataRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.athena.model.AthenaRequest

software.amazon.awssdk.services.athena.model.ListTableMetadataRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListTableMetadataRequest.Builder,ListTableMetadataRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListTableMetadataRequest
extends AthenaRequest
implements ToCopyableBuilder<ListTableMetadataRequest.Builder,ListTableMetadataRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListTableMetadataRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListTableMetadataRequest.Builder	builder()
String	catalogName()	The name of the data catalog for which table metadata should be returned.
String	databaseName()	The name of the database for which table metadata should be returned.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	expression()	A regex filter that pattern-matches table names.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	Specifies the maximum number of results to return.
String	nextToken()	A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTableMetadataRequest.Builder>	serializableBuilderClass()
ListTableMetadataRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workGroup()	The name of the workgroup for which the metadata is being fetched.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

catalogName

public final String catalogName()

The name of the data catalog for which table metadata should be returned.

Returns:

The name of the data catalog for which table metadata should be returned.

databaseName

public final String databaseName()

The name of the database for which table metadata should be returned.

Returns:

The name of the database for which table metadata should be returned.

expression

public final String expression()

A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

Returns:

A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

nextToken

public final String nextToken()

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Returns:

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

maxResults

public final Integer maxResults()

Specifies the maximum number of results to return.

Returns:

Specifies the maximum number of results to return.

workGroup

public final String workGroup()

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

Returns:

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

toBuilder

public ListTableMetadataRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTableMetadataRequest.Builder,ListTableMetadataRequest>

Specified by:

toBuilder in class AthenaRequest

builder

public static ListTableMetadataRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListTableMetadataRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo