software.amazon.awssdk.services.glue.model

Interface SearchTablesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SearchTablesRequest.Builder,SearchTablesRequest>, GlueRequest.Builder, SdkBuilder<SearchTablesRequest.Builder,SearchTablesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchTablesRequest

public static interface SearchTablesRequest.Builder
extends GlueRequest.Builder, SdkPojo, CopyableBuilder<SearchTablesRequest.Builder,SearchTablesRequest>

Method Summary

Modifier and Type	Method and Description
SearchTablesRequest.Builder	catalogId(String catalogId) A unique identifier, consisting of account_id .
SearchTablesRequest.Builder	filters(Collection<PropertyPredicate> filters) A list of key-value pairs, and a comparator used to filter the search results.
SearchTablesRequest.Builder	filters(Consumer<PropertyPredicate.Builder>... filters) A list of key-value pairs, and a comparator used to filter the search results.
SearchTablesRequest.Builder	filters(PropertyPredicate... filters) A list of key-value pairs, and a comparator used to filter the search results.
SearchTablesRequest.Builder	maxResults(Integer maxResults) The maximum number of tables to return in a single response.
SearchTablesRequest.Builder	nextToken(String nextToken) A continuation token, included if this is a continuation call.
SearchTablesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SearchTablesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SearchTablesRequest.Builder	resourceShareType(ResourceShareType resourceShareType) Allows you to specify that you want to search the tables shared with your account.
SearchTablesRequest.Builder	resourceShareType(String resourceShareType) Allows you to specify that you want to search the tables shared with your account.
SearchTablesRequest.Builder	searchText(String searchText) A string used for a text search.
SearchTablesRequest.Builder	sortCriteria(Collection<SortCriterion> sortCriteria) A list of criteria for sorting the results by a field name, in an ascending or descending order.
SearchTablesRequest.Builder	sortCriteria(Consumer<SortCriterion.Builder>... sortCriteria) A list of criteria for sorting the results by a field name, in an ascending or descending order.
SearchTablesRequest.Builder	sortCriteria(SortCriterion... sortCriteria) A list of criteria for sorting the results by a field name, in an ascending or descending order.

Methods inherited from interface software.amazon.awssdk.services.glue.model.GlueRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

catalogId

SearchTablesRequest.Builder catalogId(String catalogId)

A unique identifier, consisting of account_id .

Parameters:

catalogId - A unique identifier, consisting of account_id .

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

SearchTablesRequest.Builder nextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

SearchTablesRequest.Builder filters(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

SearchTablesRequest.Builder filters(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

SearchTablesRequest.Builder filters(Consumer<PropertyPredicate.Builder>... 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.

This is a convenience method that creates an instance of the PropertyPredicate.Builder avoiding the need to create one manually via PropertyPredicate.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on PropertyPredicate.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#filters(java.util.Collection)

searchText

SearchTablesRequest.Builder searchText(String searchText)

A string used for a text search.

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

Parameters:

searchText - A string used for a text search.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sortCriteria

SearchTablesRequest.Builder sortCriteria(Collection<SortCriterion> sortCriteria)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sortCriteria

SearchTablesRequest.Builder sortCriteria(SortCriterion... sortCriteria)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sortCriteria

SearchTablesRequest.Builder sortCriteria(Consumer<SortCriterion.Builder>... sortCriteria)

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

This is a convenience method that creates an instance of the SortCriterion.Builder avoiding the need to create one manually via SortCriterion.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #sortCriteria(List).

Parameters:

sortCriteria - a consumer that will call methods on SortCriterion.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#sortCriteria(java.util.Collection)

maxResults

SearchTablesRequest.Builder maxResults(Integer maxResults)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceShareType

SearchTablesRequest.Builder resourceShareType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceShareType, ResourceShareType

resourceShareType

SearchTablesRequest.Builder resourceShareType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceShareType, ResourceShareType

overrideConfiguration

SearchTablesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

SearchTablesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder