/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.glue.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SearchTablesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* A unique identifier, consisting of account_id
.
*
* A continuation token, included if this is a continuation call. *
*/ private String nextToken; /** ** 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.
*
* A string used for a text search. *
** Specifying a value in quotes filters based on an exact match to the value. *
*/ private String searchText; /** ** A list of criteria for sorting the results by a field name, in an ascending or descending order. *
*/ private java.util.List* The maximum number of tables to return in a single response. *
*/ private Integer maxResults; /** *
* 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.
*
* A unique identifier, consisting of account_id
.
*
account_id
.
*/
public void setCatalogId(String catalogId) {
this.catalogId = catalogId;
}
/**
*
* A unique identifier, consisting of account_id
.
*
account_id
.
*/
public String getCatalogId() {
return this.catalogId;
}
/**
*
* A unique identifier, consisting of account_id
.
*
account_id
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchTablesRequest withCatalogId(String catalogId) {
setCatalogId(catalogId);
return this;
}
/**
* * A continuation token, included if this is a continuation call. *
* * @param nextToken * A continuation token, included if this is a continuation call. */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** ** A continuation token, included if this is a continuation call. *
* * @return A continuation token, included if this is a continuation call. */ public String getNextToken() { return this.nextToken; } /** ** A continuation token, included if this is a continuation call. *
* * @param nextToken * A continuation token, included if this is a continuation call. * @return Returns a reference to this object so that method calls can be chained together. */ public SearchTablesRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** ** 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.
*
* The
* 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.
*/
public java.util.ListComparator
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.
*
* The
* A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the
* predicate.
*
* The
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
* 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.
*/
public void setFilters(java.util.CollectionComparator
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.
*
* The
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchTablesRequest withFilters(PropertyPredicate... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayListComparator
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.
*
* The
* A string used for a text search.
*
* Specifying a value in quotes filters based on an exact match to the value.
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchTablesRequest withFilters(java.util.Collection
* Specifying a value in quotes filters based on an exact match to the value. */ public void setSearchText(String searchText) { this.searchText = searchText; } /** *
* A string used for a text search. *
** Specifying a value in quotes filters based on an exact match to the value. *
* * @return A string used for a text search. ** Specifying a value in quotes filters based on an exact match to the value. */ public String getSearchText() { return this.searchText; } /** *
* A string used for a text search. *
** Specifying a value in quotes filters based on an exact match to the value. *
* * @param searchText * A string used for a text search. ** Specifying a value in quotes filters based on an exact match to the value. * @return Returns a reference to this object so that method calls can be chained together. */ public SearchTablesRequest withSearchText(String searchText) { setSearchText(searchText); return this; } /** *
* A list of criteria for sorting the results by a field name, in an ascending or descending order. *
* * @return A list of criteria for sorting the results by a field name, in an ascending or descending order. */ public java.util.List* A list of criteria for sorting the results by a field name, in an ascending or descending order. *
* * @param sortCriteria * A list of criteria for sorting the results by a field name, in an ascending or descending order. */ public void setSortCriteria(java.util.Collection* 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 * {@link #setSortCriteria(java.util.Collection)} or {@link #withSortCriteria(java.util.Collection)} if you want to * override the existing values. *
* * @param sortCriteria * A list of criteria for sorting the results by a field name, in an ascending or descending order. * @return Returns a reference to this object so that method calls can be chained together. */ public SearchTablesRequest withSortCriteria(SortCriterion... sortCriteria) { if (this.sortCriteria == null) { setSortCriteria(new java.util.ArrayList* A list of criteria for sorting the results by a field name, in an ascending or descending order. *
* * @param sortCriteria * A list of criteria for sorting the results by a field name, in an ascending or descending order. * @return Returns a reference to this object so that method calls can be chained together. */ public SearchTablesRequest withSortCriteria(java.util.Collection* The maximum number of tables to return in a single response. *
* * @param maxResults * The maximum number of tables to return in a single response. */ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** ** The maximum number of tables to return in a single response. *
* * @return The maximum number of tables to return in a single response. */ public Integer getMaxResults() { return this.maxResults; } /** ** The maximum number of tables to return in a single response. *
* * @param maxResults * The maximum number of tables to return in a single response. * @return Returns a reference to this object so that method calls can be chained together. */ public SearchTablesRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** *
* 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.
*
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.
*
* 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.
*
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.
*
* 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.
*
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.
*
* 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.
*
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.
*