com.amazonaws.services.glue.model

Class SearchTablesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glue.model.SearchTablesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchTablesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SearchTablesRequest()

Method Summary

Modifier and Type	Method and Description
SearchTablesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCatalogId() A unique identifier, consisting of account_id .
List<PropertyPredicate>	getFilters() A list of key-value pairs, and a comparator used to filter the search results.
Integer	getMaxResults() The maximum number of tables to return in a single response.
String	getNextToken() A continuation token, included if this is a continuation call.
String	getResourceShareType() Allows you to specify that you want to search the tables shared with your account.
String	getSearchText() A string used for a text search.
List<SortCriterion>	getSortCriteria() A list of criteria for sorting the results by a field name, in an ascending or descending order.
int	hashCode()
void	setCatalogId(String catalogId) A unique identifier, consisting of account_id .
void	setFilters(Collection<PropertyPredicate> filters) A list of key-value pairs, and a comparator used to filter the search results.
void	setMaxResults(Integer maxResults) The maximum number of tables to return in a single response.
void	setNextToken(String nextToken) A continuation token, included if this is a continuation call.
void	setResourceShareType(String resourceShareType) Allows you to specify that you want to search the tables shared with your account.
void	setSearchText(String searchText) A string used for a text search.
void	setSortCriteria(Collection<SortCriterion> sortCriteria) A list of criteria for sorting the results by a field name, in an ascending or descending order.
String	toString() Returns a string representation of this object.
SearchTablesRequest	withCatalogId(String catalogId) A unique identifier, consisting of account_id .
SearchTablesRequest	withFilters(Collection<PropertyPredicate> filters) A list of key-value pairs, and a comparator used to filter the search results.
SearchTablesRequest	withFilters(PropertyPredicate... filters) A list of key-value pairs, and a comparator used to filter the search results.
SearchTablesRequest	withMaxResults(Integer maxResults) The maximum number of tables to return in a single response.
SearchTablesRequest	withNextToken(String nextToken) A continuation token, included if this is a continuation call.
SearchTablesRequest	withResourceShareType(ResourceShareType resourceShareType) Allows you to specify that you want to search the tables shared with your account.
SearchTablesRequest	withResourceShareType(String resourceShareType) Allows you to specify that you want to search the tables shared with your account.
SearchTablesRequest	withSearchText(String searchText) A string used for a text search.
SearchTablesRequest	withSortCriteria(Collection<SortCriterion> sortCriteria) A list of criteria for sorting the results by a field name, in an ascending or descending order.
SearchTablesRequest	withSortCriteria(SortCriterion... sortCriteria) A list of criteria for sorting the results by a field name, in an ascending or descending order.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchTablesRequest

public SearchTablesRequest()

Method Detail

setCatalogId

public void setCatalogId(String catalogId)

A unique identifier, consisting of account_id .

Parameters:

catalogId - A unique identifier, consisting of account_id .

getCatalogId

public String getCatalogId()

A unique identifier, consisting of account_id .

Returns:

A unique identifier, consisting of account_id .

withCatalogId

public SearchTablesRequest withCatalogId(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.

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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

Returns:

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

withNextToken

public SearchTablesRequest withNextToken(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.

getFilters

public List<PropertyPredicate> getFilters()

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:

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.

setFilters

public void setFilters(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.

withFilters

public SearchTablesRequest withFilters(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.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

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.

withFilters

public SearchTablesRequest withFilters(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.

setSearchText

public void setSearchText(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.

getSearchText

public String getSearchText()

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.

withSearchText

public SearchTablesRequest withSearchText(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.

getSortCriteria

public List<SortCriterion> getSortCriteria()

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

Returns:

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

setSortCriteria

public void setSortCriteria(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.

withSortCriteria

public SearchTablesRequest withSortCriteria(SortCriterion... sortCriteria)

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

NOTE: This method appends the values to the existing list (if any). Use setSortCriteria(java.util.Collection) or withSortCriteria(java.util.Collection) if you want to override the existing values.

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.

withSortCriteria

public SearchTablesRequest withSortCriteria(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.

setMaxResults

public void setMaxResults(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.

getMaxResults

public Integer getMaxResults()

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

Returns:

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

withMaxResults

public SearchTablesRequest withMaxResults(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.

setResourceShareType

public void setResourceShareType(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.

See Also:

ResourceShareType

getResourceShareType

public String getResourceShareType()

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:

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

withResourceShareType

public SearchTablesRequest withResourceShareType(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

withResourceShareType

public SearchTablesRequest withResourceShareType(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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SearchTablesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()