Struct aws_sdk_glue::client::fluent_builders::SearchTables

pub struct SearchTables<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to SearchTables.

Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.

You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.

Implementations

impl<C, M, R> SearchTables<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<SearchTablesOutput, SdkError<SearchTablesError>> where
    R::Policy: SmithyRetryPolicy<SearchTablesInputOperationOutputAlias, SearchTablesOutput, SearchTablesError, SearchTablesInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> SearchTablesPaginator<C, M, R>

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn catalog_id(self, input: impl Into<String>) -> Self

A unique identifier, consisting of account_id .

pub fn set_catalog_id(self, input: Option<String>) -> Self

A unique identifier, consisting of account_id .

pub fn next_token(self, input: impl Into<String>) -> Self

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

pub fn set_next_token(self, input: Option<String>) -> Self

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

pub fn filters(self, input: PropertyPredicate) -> Self

Appends an item to Filters.

To override the contents of this collection use set_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.

pub fn set_filters(self, input: Option<Vec<PropertyPredicate>>) -> Self

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.

pub fn search_text(self, input: impl Into<String>) -> Self

A string used for a text search.

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

pub fn set_search_text(self, input: Option<String>) -> Self

A string used for a text search.

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

pub fn sort_criteria(self, input: SortCriterion) -> Self

Appends an item to SortCriteria.

To override the contents of this collection use set_sort_criteria.

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

pub fn set_sort_criteria(self, input: Option<Vec<SortCriterion>>) -> Self

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

pub fn max_results(self, input: i32) -> Self

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

pub fn set_max_results(self, input: Option<i32>) -> Self

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

pub fn resource_share_type(self, input: ResourceShareType) -> Self

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.

pub fn set_resource_share_type(self, input: Option<ResourceShareType>) -> Self

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.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for SearchTables<C, M, R>

fn clone(&self) -> SearchTables<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for SearchTables<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.