Package software.amazon.awssdk.services.glue.model

Class SearchTablesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.glue.model.GlueRequest

software.amazon.awssdk.services.glue.model.SearchTablesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchTablesRequest.Builder,SearchTablesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchTablesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SearchTablesRequest.Builder	builder()
String	catalogId()	A unique identifier, consisting of account_id .
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<PropertyPredicate>	filters()	A list of key-value pairs, and a comparator used to filter the search results.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
boolean	hasSortCriteria()	For responses, this returns true if the service returned a value for the SortCriteria property.
Integer	maxResults()	The maximum number of tables to return in a single response.
String	nextToken()	A continuation token, included if this is a continuation call.
ResourceShareType	resourceShareType()	Allows you to specify that you want to search the tables shared with your account.
String	resourceShareTypeAsString()	Allows you to specify that you want to search the tables shared with your account.
List<SdkField<?>>	sdkFields()
String	searchText()	A string used for a text search.
static Class<? extends SearchTablesRequest.Builder>	serializableBuilderClass()
List<SortCriterion>	sortCriteria()	A list of criteria for sorting the results by a field name, in an ascending or descending order.
SearchTablesRequest.Builder	toBuilder()
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

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

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

copy

Method Detail

catalogId

public final String catalogId()

A unique identifier, consisting of account_id .

Returns:

A unique identifier, consisting of account_id .

nextToken

public final String nextToken()

A continuation token, included if this is a continuation call.

Returns:

A continuation token, included if this is a continuation call.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

filters

public final List<PropertyPredicate> filters()

A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

Returns:

A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.

searchText

public final String searchText()

A string used for a text search.

Specifying a value in quotes filters based on an exact match to the value.

Returns:

A string used for a text search.

Specifying a value in quotes filters based on an exact match to the value.

hasSortCriteria

public final boolean hasSortCriteria()

For responses, this returns true if the service returned a value for the SortCriteria property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sortCriteria

public final List<SortCriterion> sortCriteria()

A list of criteria for sorting the results by a field name, in an ascending or descending order.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSortCriteria() method.

Returns:

A list of criteria for sorting the results by a field name, in an ascending or descending order.

maxResults

public final Integer maxResults()

The maximum number of tables to return in a single response.

Returns:

The maximum number of tables to return in a single response.

resourceShareType

public final ResourceShareType resourceShareType()

Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

• If set to FOREIGN, will search the tables shared with your account.

• If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

If the service returns an enum value that is not available in the current SDK version, resourceShareType will return ResourceShareType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceShareTypeAsString().

Returns:

Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

• If set to FOREIGN, will search the tables shared with your account.

• If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

See Also:

ResourceShareType

resourceShareTypeAsString

public final String resourceShareTypeAsString()

Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

• If set to FOREIGN, will search the tables shared with your account.

• If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

If the service returns an enum value that is not available in the current SDK version, resourceShareType will return ResourceShareType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceShareTypeAsString().

Returns:

Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

• If set to FOREIGN, will search the tables shared with your account.

• If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

See Also:

ResourceShareType

toBuilder

public SearchTablesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchTablesRequest.Builder,SearchTablesRequest>

Specified by:

toBuilder in class GlueRequest

builder

public static SearchTablesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchTablesRequest.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