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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

A unique identifier, consisting of account_id.

Returns:

  • (String)


16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16291

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

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



16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16291

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

#max_resultsInteger

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

Returns:

  • (Integer)


16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16291

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

#next_tokenString

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

Returns:

  • (String)


16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16291

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

#resource_share_typeString

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)


16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16291

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

#search_textString

A string used for a text search.

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

Returns:

  • (String)


16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16291

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

#sort_criteriaArray<Types::SortCriterion>

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

Returns:



16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16291

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