Class: Aws::LakeFormation::Types::GetTableObjectsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lakeformation/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

The catalog containing the governed table. Defaults to the caller’s account.

Returns:

  • (String)


1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
# File 'lib/aws-sdk-lakeformation/types.rb', line 1723

class GetTableObjectsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :transaction_id,
  :query_as_of_time,
  :partition_predicate,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#database_nameString

The database containing the governed table.

Returns:

  • (String)


1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
# File 'lib/aws-sdk-lakeformation/types.rb', line 1723

class GetTableObjectsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :transaction_id,
  :query_as_of_time,
  :partition_predicate,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

Specifies how many values to return in a page.

Returns:

  • (Integer)


1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
# File 'lib/aws-sdk-lakeformation/types.rb', line 1723

class GetTableObjectsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :transaction_id,
  :query_as_of_time,
  :partition_predicate,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

A continuation token if this is not the first call to retrieve these objects.

Returns:

  • (String)


1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
# File 'lib/aws-sdk-lakeformation/types.rb', line 1723

class GetTableObjectsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :transaction_id,
  :query_as_of_time,
  :partition_predicate,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#partition_predicateString

A predicate to filter the objects returned based on the partition keys defined in the governed table.

  • The comparison operators supported are: =, &gt;, &lt;, &gt;=, &lt;=

  • The logical operators supported are: AND

  • The data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss“), string and decimal.

Returns:

  • (String)


1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
# File 'lib/aws-sdk-lakeformation/types.rb', line 1723

class GetTableObjectsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :transaction_id,
  :query_as_of_time,
  :partition_predicate,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#query_as_of_timeTime

The time as of when to read the governed table contents. If not set, the most recent transaction commit time is used. Cannot be specified along with ‘TransactionId`.

Returns:

  • (Time)


1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
# File 'lib/aws-sdk-lakeformation/types.rb', line 1723

class GetTableObjectsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :transaction_id,
  :query_as_of_time,
  :partition_predicate,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#table_nameString

The governed table for which to retrieve objects.

Returns:

  • (String)


1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
# File 'lib/aws-sdk-lakeformation/types.rb', line 1723

class GetTableObjectsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :transaction_id,
  :query_as_of_time,
  :partition_predicate,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#transaction_idString

The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with ‘QueryAsOfTime`.

Returns:

  • (String)


1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
# File 'lib/aws-sdk-lakeformation/types.rb', line 1723

class GetTableObjectsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :transaction_id,
  :query_as_of_time,
  :partition_predicate,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end