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(value="software.amazon.awssdk:codegen")
public final class ListTableMetadataRequest
extends AthenaRequest
implements ToCopyableBuilder<ListTableMetadataRequest.Builder,ListTableMetadataRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListTableMetadataRequest.Builder

Method Summary

Modifier and Type	Method and 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) Indicates whether some other object is "equal to" this one by SDK fields.
String	expression() A regex filter that pattern-matches table names.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

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.

toBuilder

public ListTableMetadataRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListTableMetadataRequest.Builder,ListTableMetadataRequest>

Specified by:

toBuilder in class AthenaRequest

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.