You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Glue::Types::SearchTablesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SearchTablesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  catalog_id: "CatalogIdString",
  next_token: "Token",
  filters: [
    {
      key: "ValueString",
      value: "ValueString",
      comparator: "EQUALS", # accepts EQUALS, GREATER_THAN, LESS_THAN, GREATER_THAN_EQUALS, LESS_THAN_EQUALS
    },
  ],
  search_text: "ValueString",
  sort_criteria: [
    {
      field_name: "ValueString",
      sort: "ASC", # accepts ASC, DESC
    },
  ],
  max_results: 1,
  resource_share_type: "FOREIGN", # accepts FOREIGN, ALL
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_id ⇒ String

A unique identifier, consisting of account_id.

Returns:

  • (String) —

    A unique identifier, consisting of account_id.

#filters ⇒ Array<Types::PropertyPredicate>

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:

#max_results ⇒ Integer

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

Returns:

  • (Integer) —

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

#next_token ⇒ String

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

Returns:

  • (String) —

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

#resource_share_type ⇒ String

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.

    Possible values:

    • FOREIGN
    • ALL

Returns:

  • (String) —

    Allows you to specify that you want to search the tables shared with your account.

#search_text ⇒ String

A string used for a text search.

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

Returns:

  • (String) —

    A string used for a text search.

#sort_criteria ⇒ Array<Types::SortCriterion>

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

Returns:

  • (Array<Types::SortCriterion>) —

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