Class: Aws::Glue::Types::GetTablesRequest

Inherits:

Struct

• Object
• Struct
• Aws::Glue::Types::GetTablesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-glue/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes_to_get ⇒ Array<String>

  Specifies the table fields returned by the ‘GetTables` call.

• #audit_context ⇒ Types::AuditContext

  A structure containing the Lake Formation [audit context].

• #catalog_id ⇒ String

  The ID of the Data Catalog where the tables reside.

• #database_name ⇒ String

  The database in the catalog whose tables to list.

• #expression ⇒ String

  A regular expression pattern.

• #include_status_details ⇒ Boolean

  Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.

• #max_results ⇒ Integer

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

• #next_token ⇒ String

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

• #query_as_of_time ⇒ Time

  The time as of when to read the table contents.

• #transaction_id ⇒ String

  The transaction ID at which to read the table contents.

Instance Attribute Details

#attributes_to_get ⇒ Array<String>

Specifies the table fields returned by the ‘GetTables` call. This parameter doesn’t accept an empty list. The request must include `NAME`.

The following are the valid combinations of values:

• ‘NAME` - Names of all tables in the database.

• ‘NAME`, `TABLE_TYPE` - Names of all tables and the table types.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-glue/types.rb', line 16093

class GetTablesRequest < Struct.new(
  :catalog_id,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :transaction_id,
  :query_as_of_time,
  :audit_context,
  :include_status_details,
  :attributes_to_get)
  SENSITIVE = []
  include Aws::Structure
end

#audit_context ⇒ Types::AuditContext

A structure containing the Lake Formation [audit context].

[1]: docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html

Returns:

• (Types::AuditContext)

# File 'lib/aws-sdk-glue/types.rb', line 16093

class GetTablesRequest < Struct.new(
  :catalog_id,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :transaction_id,
  :query_as_of_time,
  :audit_context,
  :include_status_details,
  :attributes_to_get)
  SENSITIVE = []
  include Aws::Structure
end

#catalog_id ⇒ String

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 16093

class GetTablesRequest < Struct.new(
  :catalog_id,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :transaction_id,
  :query_as_of_time,
  :audit_context,
  :include_status_details,
  :attributes_to_get)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ String

The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 16093

class GetTablesRequest < Struct.new(
  :catalog_id,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :transaction_id,
  :query_as_of_time,
  :audit_context,
  :include_status_details,
  :attributes_to_get)
  SENSITIVE = []
  include Aws::Structure
end

#expression ⇒ String

A regular expression pattern. If present, only those tables whose names match the pattern are returned.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 16093

class GetTablesRequest < Struct.new(
  :catalog_id,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :transaction_id,
  :query_as_of_time,
  :audit_context,
  :include_status_details,
  :attributes_to_get)
  SENSITIVE = []
  include Aws::Structure
end

#include_status_details ⇒ Boolean

Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.

Returns:

• (Boolean)

# File 'lib/aws-sdk-glue/types.rb', line 16093

class GetTablesRequest < Struct.new(
  :catalog_id,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :transaction_id,
  :query_as_of_time,
  :audit_context,
  :include_status_details,
  :attributes_to_get)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-glue/types.rb', line 16093

class GetTablesRequest < Struct.new(
  :catalog_id,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :transaction_id,
  :query_as_of_time,
  :audit_context,
  :include_status_details,
  :attributes_to_get)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 16093

class GetTablesRequest < Struct.new(
  :catalog_id,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :transaction_id,
  :query_as_of_time,
  :audit_context,
  :include_status_details,
  :attributes_to_get)
  SENSITIVE = []
  include Aws::Structure
end

#query_as_of_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-glue/types.rb', line 16093

class GetTablesRequest < Struct.new(
  :catalog_id,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :transaction_id,
  :query_as_of_time,
  :audit_context,
  :include_status_details,
  :attributes_to_get)
  SENSITIVE = []
  include Aws::Structure
end

#transaction_id ⇒ String

The transaction ID at which to read the table contents.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 16093

class GetTablesRequest < Struct.new(
  :catalog_id,
  :database_name,
  :expression,
  :next_token,
  :max_results,
  :transaction_id,
  :query_as_of_time,
  :audit_context,
  :include_status_details,
  :attributes_to_get)
  SENSITIVE = []
  include Aws::Structure
end