Class: Aws::LakeFormation::Types::GetTableObjectsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::LakeFormation::Types::GetTableObjectsRequest
- Defined in:
- gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb
Overview
When making an API call, you may pass GetTableObjectsRequest data as a hash:
{
catalog_id: "CatalogIdString",
database_name: "NameString", # required
table_name: "NameString", # required
transaction_id: "TransactionIdString",
query_as_of_time: Time.now,
partition_predicate: "PredicateString",
max_results: 1,
next_token: "TokenString",
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#catalog_id ⇒ String
The catalog containing the governed table.
-
#database_name ⇒ String
The database containing the governed table.
-
#max_results ⇒ Integer
Specifies how many values to return in a page.
-
#next_token ⇒ String
A continuation token if this is not the first call to retrieve these objects.
-
#partition_predicate ⇒ String
A predicate to filter the objects returned based on the partition keys defined in the governed table.
-
#query_as_of_time ⇒ Time
The time as of when to read the governed table contents.
-
#table_name ⇒ String
The governed table for which to retrieve objects.
-
#transaction_id ⇒ String
The transaction ID at which to read the governed table contents.
Instance Attribute Details
#catalog_id ⇒ String
The catalog containing the governed table. Defaults to the caller’s account.
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1866 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_name ⇒ String
The database containing the governed table.
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1866 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_results ⇒ Integer
Specifies how many values to return in a page.
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1866 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_token ⇒ String
A continuation token if this is not the first call to retrieve these objects.
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1866 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_predicate ⇒ String
A predicate to filter the objects returned based on the partition keys defined in the governed table.
The comparison operators supported are: =, >, <, >=, <=
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.
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1866 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_time ⇒ Time
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
.
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1866 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_name ⇒ String
The governed table for which to retrieve objects.
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1866 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_id ⇒ String
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
.
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1866 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 |