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

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

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

Overview

Note:

When making an API call, you may pass SearchTablesRequest data as a 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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

A unique identifier, consisting of account_id/datalake.

Returns:

  • (String)


9316
9317
9318
9319
9320
9321
9322
9323
9324
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9316

class SearchTablesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :filters,
  :search_text,
  :sort_criteria,
  :max_results)
  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.

Returns:



9316
9317
9318
9319
9320
9321
9322
9323
9324
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9316

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

#max_resultsInteger

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

Returns:

  • (Integer)


9316
9317
9318
9319
9320
9321
9322
9323
9324
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9316

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

#next_tokenString

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

Returns:

  • (String)


9316
9317
9318
9319
9320
9321
9322
9323
9324
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9316

class SearchTablesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :filters,
  :search_text,
  :sort_criteria,
  :max_results)
  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)


9316
9317
9318
9319
9320
9321
9322
9323
9324
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9316

class SearchTablesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :filters,
  :search_text,
  :sort_criteria,
  :max_results)
  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:



9316
9317
9318
9319
9320
9321
9322
9323
9324
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9316

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