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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

Returns:

• (String)

# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1603

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.

Returns:

• (String)

# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1603

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1603

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.

Returns:

• (String)

# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1603

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.

Returns:

• (String)

# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1603

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.

Returns:

• (Time)

# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1603

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.

Returns:

• (String)

# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1603

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.

Returns:

• (String)

# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1603

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