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

Inherits:

Struct

• Object
• Struct
• Aws::Glue::Types::SearchTablesRequest

Defined in:

gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #catalog_id ⇒ 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.

• #include_status_details ⇒ Boolean

  Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.

• #max_results ⇒ 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.

• #resource_share_type ⇒ 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.

• #sort_criteria ⇒ Array<Types::SortCriterion>

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

Instance Attribute Details

#catalog_id ⇒ String

A unique identifier, consisting of account_id.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 25563

class SearchTablesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :filters,
  :search_text,
  :sort_criteria,
  :max_results,
  :resource_share_type,
  :include_status_details)
  SENSITIVE = []
  include Aws::Structure
end

#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:

• (Array<Types::PropertyPredicate>)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 25563

class SearchTablesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :filters,
  :search_text,
  :sort_criteria,
  :max_results,
  :resource_share_type,
  :include_status_details)
  SENSITIVE = []
  include Aws::Structure
end

#include_status_details ⇒ Boolean

Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.

Returns:

• (Boolean)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 25563

class SearchTablesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :filters,
  :search_text,
  :sort_criteria,
  :max_results,
  :resource_share_type,
  :include_status_details)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 25563

class SearchTablesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :filters,
  :search_text,
  :sort_criteria,
  :max_results,
  :resource_share_type,
  :include_status_details)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 25563

class SearchTablesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :filters,
  :search_text,
  :sort_criteria,
  :max_results,
  :resource_share_type,
  :include_status_details)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 25563

class SearchTablesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :filters,
  :search_text,
  :sort_criteria,
  :max_results,
  :resource_share_type,
  :include_status_details)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 25563

class SearchTablesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :filters,
  :search_text,
  :sort_criteria,
  :max_results,
  :resource_share_type,
  :include_status_details)
  SENSITIVE = []
  include Aws::Structure
end

#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>)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 25563

class SearchTablesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :filters,
  :search_text,
  :sort_criteria,
  :max_results,
  :resource_share_type,
  :include_status_details)
  SENSITIVE = []
  include Aws::Structure
end